|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldif.LDIFChangeRecord
com.unboundid.ldif.LDIFDeleteChangeRecord
public final class LDIFDeleteChangeRecord
This class defines an LDIF delete change record, which can be used to
represent an LDAP delete request. See the documentation for the
LDIFChangeRecord
class for an example demonstrating the process for
interacting with LDIF change records.
Constructor Summary | |
---|---|
LDIFDeleteChangeRecord(DeleteRequest deleteRequest)
Creates a new LDIF delete change record from the provided delete request. |
|
LDIFDeleteChangeRecord(java.lang.String dn)
Creates a new LDIF delete change record with the provided DN. |
|
LDIFDeleteChangeRecord(java.lang.String dn,
java.util.List<Control> controls)
Creates a new LDIF delete change record with the provided DN. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this LDIF change record. |
ChangeType |
getChangeType()
Retrieves the type of operation represented by this LDIF change record. |
int |
hashCode()
Retrieves a hash code for this change record. |
LDAPResult |
processChange(LDAPInterface connection,
boolean includeControls)
Apply the change represented by this LDIF change record to a directory server using the provided connection, optionally including any change record controls in the request. |
DeleteRequest |
toDeleteRequest()
Creates a delete request from this LDIF delete change record. |
DeleteRequest |
toDeleteRequest(boolean includeControls)
Creates a delete request from this LDIF delete change record, optionally including any change record controls in the request. |
void |
toLDIF(ByteStringBuffer buffer,
int wrapColumn)
Appends an LDIF string representation of this change record to the provided buffer. |
java.lang.String[] |
toLDIF(int wrapColumn)
Retrieves a string array whose lines contain an LDIF representation of this change record. |
void |
toLDIFString(java.lang.StringBuilder buffer,
int wrapColumn)
Appends an LDIF string representation of this change record to the provided buffer. |
void |
toString(java.lang.StringBuilder buffer)
Appends a single-line string representation of this change record to the provided buffer. |
Methods inherited from class com.unboundid.ldif.LDIFChangeRecord |
---|
getControls, getDN, getParsedDN, processChange, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDIFDeleteChangeRecord(java.lang.String dn)
dn
- The DN of the entry to delete. It must not be null
.public LDIFDeleteChangeRecord(java.lang.String dn, java.util.List<Control> controls)
dn
- The DN of the entry to delete. It must not be
null
.controls
- The set of controls for this LDIF delete change record.
It may be null
or empty if there are no controls.public LDIFDeleteChangeRecord(DeleteRequest deleteRequest)
deleteRequest
- The delete request to use to create this LDIF delete
change record. It must not be null
.Method Detail |
---|
public DeleteRequest toDeleteRequest()
public DeleteRequest toDeleteRequest(boolean includeControls)
includeControls
- Indicates whether to include any controls in the
request.
public ChangeType getChangeType()
getChangeType
in class LDIFChangeRecord
public LDAPResult processChange(LDAPInterface connection, boolean includeControls) throws LDAPException
processChange
in class LDIFChangeRecord
connection
- The connection to use to apply the change.includeControls
- Indicates whether to include any controls in the
request.
LDAPException
- If an error occurs while processing this change
in the associated directory server.public java.lang.String[] toLDIF(int wrapColumn)
toLDIF
in interface LDIFRecord
toLDIF
in class LDIFChangeRecord
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.
public void toLDIF(ByteStringBuffer buffer, int wrapColumn)
toLDIF
in interface LDIFRecord
toLDIF
in class LDIFChangeRecord
buffer
- The buffer to which to append an LDIF representation of
this change 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.public void toLDIFString(java.lang.StringBuilder buffer, int wrapColumn)
toLDIFString
in interface LDIFRecord
toLDIFString
in class LDIFChangeRecord
buffer
- The buffer to which to append an LDIF representation of
this change 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.public int hashCode()
hashCode
in class LDIFChangeRecord
public boolean equals(java.lang.Object o)
equals
in class LDIFChangeRecord
o
- The object for which to make the determination.
true
if the provided object is equal to this LDIF change
record, or false
if not.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDIFRecord
toString
in class LDIFChangeRecord
buffer
- The buffer to which the information should be written.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |