org.apache.directory.api.ldap.model.entry

Interface Modification

All Superinterfaces:

Cloneable, Externalizable, Serializable

All Known Implementing Classes:

DefaultModification

public interface Modification
extends Cloneable, Externalizable

An internal interface for a ModificationItem. The name has been chosen so that it does not conflict with @see ModificationItem

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
void	apply(AttributeType attributeType) Apply the AttributeType to the Modification
Modification	clone() The clone operation
Attribute	getAttribute()
ModificationOperation	getOperation()
void	setAttribute(Attribute attribute) Set the attribute's modification
void	setOperation(int operation) Store the modification operation
void	setOperation(ModificationOperation operation) Store the modification operation

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

getOperation

ModificationOperation getOperation()

Returns:

the operation

setOperation

void setOperation(int operation)

Store the modification operation

Parameters:

operation - The DirContext value to assign

setOperation

void setOperation(ModificationOperation operation)

Store the modification operation

Parameters:

operation - The ModificationOperation value to assign

getAttribute

Attribute getAttribute()

Returns:

the attribute containing the modifications

setAttribute

void setAttribute(Attribute attribute)

Set the attribute's modification

Parameters:

attribute - The modified attribute

clone

Modification clone()

The clone operation

Returns:

a clone of the current modification

apply

void apply(AttributeType attributeType)
    throws LdapInvalidAttributeValueException

Apply the AttributeType to the Modification

Parameters:

attributeType - the injected AttributeType

Throws:

LdapInvalidAttributeValueException - If the Modification is invalid