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:03:16 UTC
svn commit: r1066289 - in
/directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec:
ICodecControl.java IControlFactory.java IDecorator.java
Author: akarasulu
Date: Wed Feb 2 01:03:16 2011
New Revision: 1066289
URL: http://svn.apache.org/viewvc?rev=1066289&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
directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IDecorator.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=1066289&r1=1066288&r2=1066289&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:03:16 2011
@@ -26,7 +26,8 @@ import org.apache.directory.shared.ldap.
/**
- * Define the transform method to be implemented by all the codec Controls
+ * The codec uses this interface to add additional information to LDAP Model
+ * Control objects during encoding and decoding.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
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=1066289&r1=1066288&r2=1066289&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:03:16 2011
@@ -26,15 +26,26 @@ import org.apache.directory.shared.ldap.
/**
- * The LdapCodec interface, defined by the codec API.
+ * Implementors of new codec control extensions must implement a factory using
+ * this factory interface, Factory implementations for specific controls are
+ * then registered with the codec and used by the codec to encode and decode
+ * those controls.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
*/
public interface IControlFactory<C extends Control, D extends ICodecControl<C>>
{
+ /**
+ * @return The OID of the Control this factory creates.
+ */
String getOid();
-
+
+
+ /**
+ *
+ * @return
+ */
D newCodecControl();
D decorate( C modelControl );
Modified: directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IDecorator.java?rev=1066289&r1=1066288&r2=1066289&view=diff
==============================================================================
--- directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IDecorator.java (original)
+++ directory/shared/branches/m1/ldap/src/main/java/org/apache/directory/shared/ldap/codec/IDecorator.java Wed Feb 2 01:03:16 2011
@@ -26,8 +26,9 @@ import org.apache.directory.shared.asn1.
/**
- * A decorator interface exposing the ComputeLength and encode methods.
- *
+ * The codec uses this interface to add additional information to LDAP Model
+ * objects during encoding and decoding,
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public interface IDecorator<E>