Skip navigation links

com.octetstring.vde
Class EntryChange

java.lang.Object
com.octetstring.vde.EntryChange

All Implemented Interfaces:

java.io.Serializable

public class EntryChange

extends java.lang.Object

implements java.io.Serializable

Class whose instances contain a single LDAP modification. A single modification is a request to add, remove, or replace values for a single attribute.

See Also:

Serialized Form

Field Summary

DirectoryString	attr
static int	MOD_ADD
static int	MOD_DELETE
static int	MOD_REPLACE
java.util.Vector<? extends Syntax>	values

Constructor Summary

EntryChange()
Creates a new EntryChange without initializing any internal values.

EntryChange(byte[] entryChangeBytes)
Creates a new EntryChange using an array of bytes.

EntryChange(int modType, DirectoryString attr, java.util.Vector<? extends Syntax> values)
Creates a new EntryChange given basic information about the change.

Method Summary

byte[]	getAsByteArray() Get this EntryChange as a byte array.
DirectoryString	getAttr() Retrieves the attribute type associated with this change.
int	getModType() Retrieves the modification type associated with this change.
java.util.Vector<? extends Syntax>	getValues() Retrieves the values associated with this change.
void	setAttr(DirectoryString newAttr) Sets the attribute type associated with this change.
void	setModType(int newModType) Sets the modification type associated with this change.
void	setValues(java.util.Vector<? extends Syntax> newValues) Set the list of changes associated with this change.
java.lang.String	toLDIF() Retrieves the value of this change as an LDIF-formatted string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MOD_ADD

public static final int MOD_ADD

See Also:

Constant Field Values

MOD_DELETE

public static final int MOD_DELETE

See Also:

Constant Field Values

MOD_REPLACE

public static final int MOD_REPLACE

See Also:

Constant Field Values

attr

public DirectoryString attr

values

public java.util.Vector<? extends Syntax> values

Constructor Detail

EntryChange

public EntryChange()

Creates a new EntryChange without initializing any internal values.

EntryChange

public EntryChange(byte[] entryChangeBytes)

Creates a new EntryChange using an array of bytes.

Parameters:

entryChangeBytes - an array of bytes. Such an array can be generated using the getAsByteArray method. Typically used for reading an EntryChange from disk or other media holding information as an array of bytes.

EntryChange

public EntryChange(int modType,
                   DirectoryString attr,
                   java.util.Vector<? extends Syntax> values)

Creates a new EntryChange given basic information about the change.

Parameters:

modType - the modification type

attr - the attribute type being modified ("cn" for example)

values - a list of values that will be used as per the modType

Method Detail

getAttr

public DirectoryString getAttr()

Retrieves the attribute type associated with this change.

Returns:

an attribute type

setAttr

public void setAttr(DirectoryString newAttr)

Sets the attribute type associated with this change.

Parameters:

newAttr - the new attribute type

getModType

public int getModType()

Retrieves the modification type associated with this change.

Returns:

a modification type

setModType

public void setModType(int newModType)

Sets the modification type associated with this change.

Parameters:

newModType - a modification type

getValues

public java.util.Vector<? extends Syntax> getValues()

Retrieves the values associated with this change.

Returns:

a Vector of attribute values with each element being an instance of a class implementing the Syntax interface.

setValues

public void setValues(java.util.Vector<? extends Syntax> newValues)

Set the list of changes associated with this change.

Parameters:

newValues - values associated with this change. Each element of the Vector is an object of a class implementing the Syntax interface.

getAsByteArray

public byte[] getAsByteArray()

Get this EntryChange as a byte array. Offers a representation of this object that can be easily written to disk or persisted in other ways.

Returns:

a byte array representation of this change

toLDIF

public java.lang.String toLDIF()

Retrieves the value of this change as an LDIF-formatted string.

Returns:

an LDIF-formatted string per the published IETF Internet Draft on ChangeLog entries.

Skip navigation links