Package netscape.ldap
Class LDAPModificationSet
java.lang.Object
netscape.ldap.LDAPModificationSet
- All Implemented Interfaces:
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.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(int op, LDAPAttribute attr) Specifies another modification to be added to the set of modifications.elementAt
(int index) Retrieves a particularLDAPModification
object at the position specified by the index.void
Removes the first attribute with the specified name in the set of modifications.void
removeElementAt
(int index) Removes a particularLDAPModification
object at the position specified by the index.int
size()
Retrieves the number ofLDAPModification
objects in this set.toString()
Retrieves the string representation of the modification set.
-
Constructor Details
-
LDAPModificationSet
public LDAPModificationSet()Constructs a new, empty set of modifications. You can add modifications to this set by calling theLDAPModificationsSet.add
method.
-
-
Method Details
-
size
public int size()Retrieves the number ofLDAPModification
objects in this set.- Returns:
- the number of
LDAPModification
objects in this set.
-
elementAt
Retrieves a particularLDAPModification
object at the position specified by the index.- Parameters:
index
- position of theLDAPModification
object that you want to retrieve.- Returns:
LDAPModification
object representing a change to make to an attribute.
-
removeElementAt
public void removeElementAt(int index) Removes a particularLDAPModification
object at the position specified by the index.- Parameters:
index
- position of theLDAPModification
object that you want to remove
-
add
Specifies another modification to be added to the set of modifications.- Parameters:
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
-
remove
Removes the first attribute with the specified name in the set of modifications.- Parameters:
name
- name of the attribute to remove
-
toString
Retrieves the string representation of the modification set.
-