netscape.ldap
Class LDAPModificationSet
java.lang.Object
netscape.ldap.LDAPModificationSet
- java.io.Serializable
public class LDAPModificationSet
extends java.lang.Object
implements java.io.Serializable
Represents a set of modifications to be made to attributes in an entry.
A set of modifications is made up of
LDAPModification
objects.
After you specify a change to an attribute, you can execute the change
by calling the
LDAPConnection.modify
method and specifying
the DN of the entry that you want to modify.
void | add(int op, LDAPAttribute attr) - Specifies another modification to be added to the set of modifications.
|
LDAPModification | elementAt(int index) - Retrieves a particular
LDAPModification object at
the position specified by the index.
|
void | remove(String name) - Removes the first attribute with the specified name in the set of modifications.
|
void | removeElementAt(int index) - Removes a particular
LDAPModification object at
the position specified by the index.
|
int | size() - Retrieves the number of
LDAPModification
objects in this set.
|
String | toString() - Retrieves the string representation of the
modification set.
|
LDAPModificationSet
public LDAPModificationSet()
Constructs a new, empty set of modifications.
You can add modifications to this set by calling the
LDAPModificationsSet.add
method.
add
public void add(int op,
LDAPAttribute attr)
Specifies another modification to be added to the set of modifications.
op
- the type of modification to make. This can be one of the following:
LDAPModification.ADD
(the value should be added to the attribute)
LDAPModification.DELETE
(the value should be removed from the attribute)
LDAPModification.REPLACE
(the value should replace the existing value of the attribute)
If you are working with a binary value (not a string value), you need to bitwise OR (|) the
modification type with LDAPModification.BVALUES
.
attr
- the attribute (possibly with values) to modify
elementAt
public LDAPModification elementAt(int index)
Retrieves a particular LDAPModification
object at
the position specified by the index.
index
- position of the LDAPModification
object that you want to retrieve.
LDAPModification
object representing
a change to make to an attribute.
remove
public void remove(String name)
Removes the first attribute with the specified name in the set of modifications.
name
- name of the attribute to remove
removeElementAt
public void removeElementAt(int index)
Removes a particular LDAPModification
object at
the position specified by the index.
index
- position of the LDAPModification
object that you want to remove
size
public int size()
Retrieves the number of LDAPModification
objects in this set.
- the number of
LDAPModification
objects in this set.
toString
public String toString()
Retrieves the string representation of the
modification set.
- string representation of the modification set.