javax.naming.directory
Class ModificationItem
java.lang.Object
|
+--javax.naming.directory.ModificationItem
- public class ModificationItem
- extends java.lang.Object
- implements java.io.Serializable
This class represents a modification item.
It consists of a modification code and an attribute on which to operate.
A ModificationItem instance is not synchronized against concurrent
multithreaded access. Multiple threads trying to access and modify
a single ModificationItem instance should lock the object.
- See Also:
- Serialized Form
Method Summary |
Attribute |
getAttribute()
Retrieves the attribute associated with this modification item. |
int |
getModificationOp()
Retrieves the modification code of this modification item. |
java.lang.String |
toString()
Generates the string representation of this modification item,
which consists of the modification operation and its related attribute. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
ModificationItem
public ModificationItem(int mod_op,
Attribute attr)
- Creates a new instance of ModificationItem.
- Parameters:
mod_op
- Modification to apply. It must be one of:
DirContext.ADD_ATTRIBUTE
DirContext.REPLACE_ATTRIBUTE
DirContext.REMOVE_ATTRIBUTEattr
- The non-null attribute to use for modification.- Throws:
- java.lang.IllegalArgumentException - If attr is null, or if mod_op is
not one of the ones specified above.
getModificationOp
public int getModificationOp()
- Retrieves the modification code of this modification item.
- Returns:
- The modification code. It is one of:
DirContext.ADD_ATTRIBUTE
DirContext.REPLACE_ATTRIBUTE
DirContext.REMOVE_ATTRIBUTE
getAttribute
public Attribute getAttribute()
- Retrieves the attribute associated with this modification item.
- Returns:
- The non-null attribute to use for the modification.
toString
public java.lang.String toString()
- Generates the string representation of this modification item,
which consists of the modification operation and its related attribute.
The string representation is meant for debugging and not to be
interpreted programmatically.
- Returns:
- The non-null string representation of this modification item.
- Overrides:
- toString in class java.lang.Object
For more information on JNDI, please see http://java.sun.com/products/jndi