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

    Constructors
    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 Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • 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.