org.opends.server.api
Interface ProtocolElement

All Known Implementing Classes:

ASN1Boolean, ASN1Element, ASN1Enumerated, ASN1Integer, ASN1Long, ASN1Null, ASN1OctetString, ASN1Sequence, ASN1Set, Entry, LDAPMessage, SearchResultEntry

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=true)
public interface ProtocolElement

This interface defines a set of methods that must be implemented by any class that forms the basis for a protocol element (e.g., an ASN.1 element, an LDAP message, etc.).

Method Summary

java.lang.String	getProtocolElementName() Retrieves the name of the protocol associated with this protocol element.
java.lang.String	toString() Retrieves a string representation of this protocol element.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this protocol element to the provided buffer.
void	toString(java.lang.StringBuilder buffer, int indent) Appends a string representation of this protocol element to the provided buffer.

Method Detail

getProtocolElementName

java.lang.String getProtocolElementName()

Retrieves the name of the protocol associated with this protocol element.

Returns:

The name of the protocol associated with this protocol element.

toString

java.lang.String toString()

Retrieves a string representation of this protocol element.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this protocol element.

toString

void toString(java.lang.StringBuilder buffer)

Appends a string representation of this protocol element to the provided buffer.

Parameters:

buffer - The buffer into which the string representation should be written.

toString

void toString(java.lang.StringBuilder buffer,
              int indent)

Appends a string representation of this protocol element to the provided buffer.

Parameters:

buffer - The buffer into which the string representation should be written.

indent - The number of spaces that should be used to indent the resulting string representation.