Class ModificationItem

java.lang.Object
javax.naming.directory.ModificationItem
All Implemented Interfaces:
Serializable
public class ModificationItem extends Object implements 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.

Since:
1.3
See Also:

Constructor Summary

Constructor Description
ModificationItem(int mod_op, Attribute attr)
Creates a new instance of ModificationItem.

Method Summary

Modifier and Type Method Description
Attribute getAttribute()
Retrieves the attribute associated with this modification item.
int getModificationOp()
Retrieves the modification code of this modification item.
String toString()
Generates the string representation of this modification item, which consists of the modification operation and its related attribute.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

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_ATTRIBUTE
attr - The non-null attribute to use for modification.
Throws:
IllegalArgumentException - If attr is null, or if mod_op is not one of the ones specified above.

Method Details

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 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.
Overrides:
toString in class Object
Returns:
The non-null string representation of this modification item.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/directory/ModificationItem.html