Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id C497868BF for ; Tue, 14 Jun 2011 13:52:44 +0000 (UTC) Received: (qmail 32964 invoked by uid 500); 14 Jun 2011 13:52:44 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 32910 invoked by uid 500); 14 Jun 2011 13:52:44 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 32903 invoked by uid 99); 14 Jun 2011 13:52:44 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Jun 2011 13:52:44 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Jun 2011 13:52:43 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 6DD0B23889EA; Tue, 14 Jun 2011 13:52:23 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1135579 - /commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classvisitor/Key.java Date: Tue, 14 Jun 2011 13:52:23 -0000 To: commits@commons.apache.org From: simonetripodi@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110614135223.6DD0B23889EA@eris.apache.org> Author: simonetripodi Date: Tue Jun 14 13:52:23 2011 New Revision: 1135579 URL: http://svn.apache.org/viewvc?rev=1135579&view=rev Log: filled missing javadoc Modified: commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classvisitor/Key.java Modified: commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classvisitor/Key.java URL: http://svn.apache.org/viewvc/commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classvisitor/Key.java?rev=1135579&r1=1135578&r2=1135579&view=diff ============================================================================== --- commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classvisitor/Key.java (original) +++ commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classvisitor/Key.java Tue Jun 14 13:52:23 2011 @@ -25,7 +25,8 @@ import java.lang.annotation.Annotation; import java.lang.reflect.AnnotatedElement; /** - * FILL ME. + * A {@code Key} is a support class to quickly access to {@code AnnotationHandler}s given + * the {@link AnnotatedElement} type and the {@link Annotation} type. */ final class Key { @@ -34,17 +35,33 @@ final class Key private final Class annotationType; + /** + * Creates a new {@code Key} given the {@link AnnotatedElement} and the {@link Annotation} types. + * + * @param annotatedElementType the {@link AnnotatedElement} type + * @param annotationType the {@link Annotation} type + */ public Key( Class annotatedElementType, Class annotationType ) { this.annotatedElementType = annotatedElementType; this.annotationType = annotationType; } + /** + * Returns the {@link AnnotatedElement} type represented by this {@code Key}. + * + * @return the {@link AnnotatedElement} type represented by this {@code Key}. + */ protected Class getAnnotatedElementType() { return annotatedElementType; } + /** + * Returns the {@link Annotation} type represented by this {@code Key}. + * + * @return the {@link Annotation} type represented by this {@code Key}. + */ protected Class getAnnotationType() { return annotationType;