leosutic 2003/12/28 12:43:09
Modified: attributes/api/src/java/org/apache/commons/attributes
AttributeRepositoryClass.java
Log:
Improved Javadoc
Revision Changes Path
1.4 +38 -0
jakarta-commons-sandbox/attributes/api/src/java/org/apache/commons/attributes/AttributeRepositoryClass.java
Index: AttributeRepositoryClass.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/attributes/api/src/java/org/apache/commons/attributes/AttributeRepositoryClass.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AttributeRepositoryClass.java 12 Oct 2003 09:07:30 -0000 1.3
+++ AttributeRepositoryClass.java 28 Dec 2003 20:43:09 -0000 1.4
@@ -66,8 +66,46 @@
* classes implementing it may be in any package.
*/
public interface AttributeRepositoryClass {
+
+ /**
+ * Returns a set containing all attributes (instances) associated with this
class.
+ * Should not return any attributes of superclasses etc.
+ */
public Set getClassAttributes ();
+
+ /**
+ * Returns a map with String keys and Set values. The keys correspond to field
names,
+ * and their associated Set values are the set of all attributes (instances)
associated with that field.
+ * Should not return any attributes of superclasses etc.
+ */
public Map getFieldAttributes ();
+
+ /**
+ * Returns a map with String keys and List values. The keys correspond to
method signatures,
+ * given by get Util.getSignature method, and the lists are as follows:<p>
+ *
+ * list.get(0) = A Set with the attributes associated with the method.<p>
+ * list.get(1) = A Set with the attributes associated with the method's return
value.<p>
+ * list.get(2) = A Set with the attributes associated with the method's first
parameter.<p>
+ * list.get(n) = A Set with the attributes associated with the method's (n - 1)
th parameter.<p>
+ *
+ * All slots in the list must be filled, not just those where there are
attributes.
+ *
+ * Should not return any attributes of superclasses etc.
+ */
public Map getMethodAttributes ();
+
+ /**
+ * Returns a map with String keys and List values. The keys correspond to
constructor signatures,
+ * given by get Util.getSignature method, and the lists are as follows:<p>
+ *
+ * list.get(0) = A Set with the attributes associated with the constructor.<p>
+ * list.get(1) = A Set with the attributes associated with the constructor's
first parameter.<p>
+ * list.get(n) = A Set with the attributes associated with the constructor's (n
- 1) th parameter.<p>
+ *
+ * All slots in the list must be filled, not just those where there are
attributes.
+ *
+ * Should not return any attributes of superclasses etc.
+ */
public Map getConstructorAttributes ();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
