|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LDIFRecord
This interface defines a common API for LDIF records, which are objects that
can be represented using LDIF. This includes both
com.unboundid.ldap.sdk.Entry
and LDIFChangeRecord
objects.
It is possible to obtain the DN of an LDIF record, as well as to obtain the
LDIF representation of that object. They can be read using the
LDIFReader#readLDIFRecord
method and written using the
LDIFWriter#writeLDIFRecord
method.
This interface defines a data type that is intended to be implemented only
by classes within the LDAP SDK. Third-party code may reference objects using
this data type, but external classes should not create additional
implementations of this interface.
Method Summary | |
---|---|
java.lang.String |
getDN()
Retrieves the string representation of the DN for this LDIF record. |
DN |
getParsedDN()
Retrieves the parsed DN for this LDIF record as a DN object. |
java.lang.String[] |
toLDIF()
Retrieves an LDIF representation of this LDIF record, with each line of the LDIF representation in a separate element of the returned array. |
void |
toLDIF(ByteStringBuffer buffer)
Appends an LDIF-formatted string representation of this LDIF record to the provided buffer. |
void |
toLDIF(ByteStringBuffer buffer,
int wrapColumn)
Appends an LDIF-formatted string representation of this LDIF record to the provided buffer. |
java.lang.String[] |
toLDIF(int wrapColumn)
Retrieves an LDIF representation of this LDIF record, with each line of the LDIF representation in a separate element of the returned array. |
java.lang.String |
toLDIFString()
Retrieves an LDIF-formatted string representation of this LDIF record. |
java.lang.String |
toLDIFString(int wrapColumn)
Retrieves an LDIF-formatted string representation of this LDIF record. |
void |
toLDIFString(java.lang.StringBuilder buffer)
Appends an LDIF-formatted string representation of this LDIF record to the provided buffer. |
void |
toLDIFString(java.lang.StringBuilder buffer,
int wrapColumn)
Appends an LDIF-formatted string representation of this LDIF record to the provided buffer. |
java.lang.String |
toString()
Retrieves a string representation of this LDIF record. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDIF record to the provided buffer. |
Method Detail |
---|
java.lang.String getDN()
DN getParsedDN() throws LDAPException
DN
object.
DN
object.
LDAPException
- If a problem occurs while trying to parse the DN.java.lang.String[] toLDIF()
java.lang.String[] toLDIF(int wrapColumn)
wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.
void toLDIF(ByteStringBuffer buffer)
buffer
- The buffer to which to append the LDIF representation of
this LDIF record.void toLDIF(ByteStringBuffer buffer, int wrapColumn)
buffer
- The buffer to which to append the LDIF representation
of this LDIF record.wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.java.lang.String toLDIFString()
java.lang.String toLDIFString(int wrapColumn)
wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.
void toLDIFString(java.lang.StringBuilder buffer)
buffer
- The buffer to which to append the LDIF representation of
this LDIF record.void toLDIFString(java.lang.StringBuilder buffer, int wrapColumn)
buffer
- The buffer to which to append the LDIF representation
of this LDIF record.wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.java.lang.String toString()
toString
in class java.lang.Object
void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the string representation of this LDIF
record should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |