Package org.opends.server.protocols.ldap

Class LDAPModification

java.lang.Object

org.opends.server.types.RawModification

org.opends.server.protocols.ldap.LDAPModification

public class LDAPModification
extends RawModification

This class defines the data structures and methods to use when interacting with an LDAP modification, which describes a change that should be made to an attribute.

Constructor Summary

Constructors

Constructor	Description
LDAPModification(ModificationType modificationType, RawAttribute attribute)	Creates a new LDAP modification with the provided type and attribute.

Method Summary

Modifier and Type	Method	Description
RawAttribute	getAttribute()	Retrieves the attribute for this modification.
ModificationType	getModificationType()	Retrieves the modification type for this modification.
void	setAttribute(RawAttribute attribute)	Specifies the attribute for this modification.
void	setModificationType(ModificationType modificationType)	Specifies the modification type for this modification.
Modification	toModification()	Creates a new core Modification object from this LDAP modification.
String	toString()	Retrieves a string representation of this modification.
void	toString(StringBuilder buffer)	Appends a string representation of this modification to the provided buffer.
void	toString(StringBuilder buffer, int indent)	Appends a multi-line string representation of this LDAP modification to the provided buffer.

Methods inherited from class org.opends.server.types.RawModification

create, create, create, create, create, decode, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LDAPModification

public LDAPModification(ModificationType modificationType,
                        RawAttribute attribute)

Creates a new LDAP modification with the provided type and attribute.

Parameters:

modificationType - The modification type for this modification.

attribute - The attribute for this modification.

Method Detail

getModificationType

public ModificationType getModificationType()

Retrieves the modification type for this modification.

Specified by:

getModificationType in class RawModification

Returns:

The modification type for this modification.

setModificationType

public void setModificationType(ModificationType modificationType)

Specifies the modification type for this modification.

Specified by:

setModificationType in class RawModification

Parameters:

modificationType - The modification type for this modification.

getAttribute

public RawAttribute getAttribute()

Retrieves the attribute for this modification.

Specified by:

getAttribute in class RawModification

Returns:

The attribute for this modification.

setAttribute

public void setAttribute(RawAttribute attribute)

Specifies the attribute for this modification.

Specified by:

setAttribute in class RawModification

Parameters:

attribute - The attribute for this modification.

toModification

public Modification toModification()
                            throws LDAPException

Creates a new core Modification object from this LDAP modification.

Specified by:

toModification in class RawModification

Returns:

The decoded modification.

Throws:

LDAPException - If a problem occurs while trying to convert the LDAP attribute to a core Attribute.

toString

public String toString()

Retrieves a string representation of this modification.

Overrides:

toString in class RawModification

Returns:

A string representation of this modification.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this modification to the provided buffer.

Specified by:

toString in class RawModification

Parameters:

buffer - The buffer to which the information should be appended.

toString

public void toString(StringBuilder buffer,
                     int indent)

Appends a multi-line string representation of this LDAP modification to the provided buffer.

Specified by:

toString in class RawModification

Parameters:

buffer - The buffer to which the information should be appended.

indent - The number of spaces from the margin that the lines should be indented.