commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
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 GMT
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<? extends Annotation> 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<? extends AnnotatedElement> annotatedElementType, Class<?
extends Annotation> 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<? extends AnnotatedElement> 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<? extends Annotation> getAnnotationType()
     {
         return annotationType;



Mime
View raw message