directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r655486 - /directory/apacheds/trunk/core-entry/src/main/java/org/apache/directory/server/core/entry/DefaultServerAttribute.java
Date Mon, 12 May 2008 12:03:23 GMT
Author: elecharny
Date: Mon May 12 05:03:23 2008
New Revision: 655486

URL: http://svn.apache.org/viewvc?rev=655486&view=rev
Log:
Added the missing Javadoc

Modified:
    directory/apacheds/trunk/core-entry/src/main/java/org/apache/directory/server/core/entry/DefaultServerAttribute.java

Modified: directory/apacheds/trunk/core-entry/src/main/java/org/apache/directory/server/core/entry/DefaultServerAttribute.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/core-entry/src/main/java/org/apache/directory/server/core/entry/DefaultServerAttribute.java?rev=655486&r1=655485&r2=655486&view=diff
==============================================================================
--- directory/apacheds/trunk/core-entry/src/main/java/org/apache/directory/server/core/entry/DefaultServerAttribute.java
(original)
+++ directory/apacheds/trunk/core-entry/src/main/java/org/apache/directory/server/core/entry/DefaultServerAttribute.java
Mon May 12 05:03:23 2008
@@ -54,6 +54,9 @@
     // -----------------------------------------------------------------------
     /**
      * Private helper method used to set an UpId from an attributeType
+     * 
+     * @param at The attributeType for which we want the upID
+     * @return the ID of the given attributeType
      */
     private String getUpId( AttributeType at )
     {
@@ -377,6 +380,8 @@
     // an initial value as a string or a byte[]
     /**
      * Create a new instance of a EntryAttribute, without ID nor value.
+     * 
+     * @param attributeType the attributeType for the empty attribute added into the entry
      */
     public DefaultServerAttribute( AttributeType attributeType )
     {
@@ -391,6 +396,9 @@
 
     /**
      * Create a new instance of a EntryAttribute, without value.
+     * 
+     * @param upId the ID for the added attributeType
+     * @param attributeType the added AttributeType
      */
     public DefaultServerAttribute( String upId, AttributeType attributeType )
     {
@@ -431,7 +439,7 @@
      * 
      * Otherwise, the value is stored, but as a reference. It's not a copy.
      *
-     * @param upId
+     * @param upId the ID of the added attribute
      * @param attributeType the attribute type according to the schema
      * @param vals an initial set of values for this attribute
      */
@@ -450,6 +458,9 @@
 
     /**
      * Create a new instance of a EntryAttribute, without ID but with some values.
+     * 
+     * @param attributeType The attributeType added on creation
+     * @param vals The added value for this attribute
      */
     public DefaultServerAttribute( AttributeType attributeType, String... vals )
     {
@@ -459,6 +470,10 @@
 
     /**
      * Create a new instance of a EntryAttribute.
+     * 
+     * @param upId the ID for the added attribute
+     * @param attributeType The attributeType added on creation
+     * @param vals the added values for this attribute
      */
     public DefaultServerAttribute( String upId, AttributeType attributeType, String... vals
)
     {
@@ -475,6 +490,9 @@
 
     /**
      * Create a new instance of a EntryAttribute, with some byte[] values.
+     * 
+     * @param attributeType The attributeType added on creation
+     * @param vals The value for the added attribute
      */
     public DefaultServerAttribute( AttributeType attributeType, byte[]... vals )
     {
@@ -484,6 +502,10 @@
 
     /**
      * Create a new instance of a EntryAttribute, with some byte[] values.
+     * 
+     * @param upId the ID for the added attribute
+     * @param attributeType the AttributeType to be added
+     * @param vals the values for the added attribute
      */
     public DefaultServerAttribute( String upId, AttributeType attributeType, byte[]... vals
)
     {
@@ -502,6 +524,8 @@
      * Clone an attribute. All the element are duplicated, so a modification on
      * the original object won't affect the cloned object, as a modification
      * on the cloned object has no impact on the original object
+     * 
+     * @return a clone of the current attribute
      */
     public ServerAttribute clone()
     {
@@ -564,6 +588,8 @@
 
     /**
      * @see EntryAttribute#add(org.apache.directory.shared.ldap.entry.Value...)
+     * 
+     * @return the number of added values into this attribute
      */
     public int add( Value<?>... vals )
     {
@@ -916,6 +942,8 @@
     
     /**
      * @see EntryAttribute#remove(org.apache.directory.shared.ldap.entry.Value...)
+     * 
+     * @return <code>true</code> if all the values shave been removed from this
attribute
      */
     public boolean remove( Value<?>... vals )
     {
@@ -969,6 +997,8 @@
 
     /**
      * @see EntryAttribute#remove(byte[]...)
+     * 
+     * @return <code>true</code> if all the values shave been removed from this
attribute
      */
     public boolean remove( byte[]... vals )
     {
@@ -991,6 +1021,8 @@
 
     /**
      * @see EntryAttribute#remove(String...)
+     * 
+     * @return <code>true</code> if all the values shave been removed from this
attribute
      */
     public boolean remove( String... vals )
     {
@@ -1019,6 +1051,8 @@
      * on the internal values.
      *  
      * @see Object#hashCode()
+     * 
+     * @return the instance's hashcode 
      */
     public int hashCode()
     {
@@ -1035,6 +1069,8 @@
 
     /**
      * @see Object#equals(Object)
+     * 
+     * @return <code>true</code> if the two objects are equal
      */
     public boolean equals( Object obj )
     {
@@ -1073,7 +1109,9 @@
     
     
     /**
-     * @see Object#toString() 
+     * @see Object#toString()
+     * 
+     * @return A String representation of this instance
      */
     public String toString()
     {



Mime
View raw message