Author: akarasulu Date: Tue Sep 28 21:16:46 2004 New Revision: 47455 Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/message/MessageDecoder.java Log: some javadoc addition
Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/message/MessageDecoder.java ============================================================================== --- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/message/MessageDecoder.java (original) +++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/message/MessageDecoder.java Tue Sep 28 21:16:46 2004 @@ -34,8 +34,7 @@ * Decodes a BER encoded LDAPv3 message envelope from an input stream * demarshaling it into a Message instance using a BER library provider. * - * @author <a href="mailto:[EMAIL PROTECTED]"> Apache Directory - * Project</a> + * @author <a href="mailto:[EMAIL PROTECTED]">Apache Directory Project</a> * @version $Rev$ */ public final class MessageDecoder implements StatefulDecoder @@ -131,10 +130,11 @@ /** - * @todo doc me! + * Decodes a chunk of stream data returning any resultant decoded PDU via + * a callback. * - * @param chunk - * @throws MessageException + * @param chunk the chunk to decode + * @throws MessageException if there are failures while decoding the chunk */ public void decode( Object chunk ) throws MessageException { @@ -150,9 +150,9 @@ /** - * @todo doc me! + * Sets the callback used to deliver completly decoded PDU's. * - * @param cb + * @param cb the callback to use for decoded PDU delivery */ public void setCallback( DecoderCallback cb ) { @@ -161,9 +161,10 @@ /** - * @todo doc me! + * Sets the monitor for this MessageDecoder which receives callbacks for + * noteworthy events during decoding. * - * @param monitor + * @param monitor the monitor to receive notifications via callback events */ public void setDecoderMonitor( DecoderMonitor monitor ) {
