You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by ak...@apache.org on 2011/02/02 02:38:08 UTC
svn commit: r1066300 - in
/directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec:
ICodecControl.java IControlFactory.java
Author: akarasulu
Date: Wed Feb 2 01:38:08 2011
New Revision: 1066300
URL: http://svn.apache.org/viewvc?rev=1066300&view=rev
Log:
adding some javadocs
Modified:
directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/ICodecControl.java
directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IControlFactory.java
Modified: directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/ICodecControl.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/ICodecControl.java?rev=1066300&r1=1066299&r2=1066300&view=diff
==============================================================================
--- directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/ICodecControl.java (original)
+++ directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/ICodecControl.java Wed Feb 2 01:38:08 2011
@@ -50,17 +50,17 @@ public interface ICodecControl<E extends
/**
- * Get the control value
+ * Gets the binary ASN.1 BER encoded representation of the control.
*
- * @return The control value
+ * @return The control's encoded value
*/
byte[] getValue();
/**
- * Set the encoded control value
+ * Set the Control's encoded control value.
*
- * @param value The encoded control value to store
+ * @param value The encoded control value to store.
*/
void setValue( byte[] value );
}
Modified: directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IControlFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IControlFactory.java?rev=1066300&r1=1066299&r2=1066300&view=diff
==============================================================================
--- directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IControlFactory.java (original)
+++ directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IControlFactory.java Wed Feb 2 01:38:08 2011
@@ -43,13 +43,26 @@ public interface IControlFactory<C exten
/**
+ * Creates and returns a decorated version of the Control.
*
- * @return
+ * @return The {@link ICodecControl} decorated version of the Control.
*/
D newCodecControl();
-
- D decorate( C modelControl );
-
+
+
+ /**
+ * Decorates an existing control.
+ *
+ * @param control The {@link Control} to be decorated.
+ * @return The decorator wrapped version of the Control.
+ */
+ D decorate( C control );
+
+
+ /**
+ *
+ * @return
+ */
C newControl();
javax.naming.ldap.Control toJndiControl( C modelControl ) throws EncoderException;