Package org.forgerock.opendj.ldap

Class ModificationType

java.lang.Object
org.forgerock.opendj.ldap.ModificationType
public final class ModificationType extends Object
A Modify operation change type as defined in RFC 4511 section 4.6 is used to specify the type of modification being performed on an attribute.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ModificationType.Enum
    Contains equivalent values for the ModificationType values.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ModificationType
    ADD
    Add the values listed in the modification to the attribute, creating the attribute if necessary.
    static final ModificationType
    DELETE
    Delete the values listed in the modification from the attribute.
    static final ModificationType
    INCREMENT
    Increment all existing values of the attribute by the amount specified in the modification value.
    static final ModificationType
    REPLACE
    Replace all existing values of the attribute with the new values listed in the modification, creating the attribute if it did not already exist.

  • Method Summary

    Modifier and Type
    Method
    Description
    ModificationType.Enum
    asEnum()
    Returns the enum equivalent for this modification type.
    boolean
    equals(Object obj)
     
    int
    hashCode()
     
    int
    intValue()
    Returns the integer value of this modification change type as defined in RFC 4511 section 4.6.
    String
    toString()
    Returns the string representation of this modification change type.
    static ModificationType
    valueOf(int intValue)
    Returns the modification change type having the specified integer value as defined in RFC 4511 section 4.6.
    static List<ModificationType>
    values()
    Returns an unmodifiable list containing the set of available modification change types indexed on their integer value as defined in RFC 4511 section 4.6.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • ADD

      public static final ModificationType ADD
      Add the values listed in the modification to the attribute, creating the attribute if necessary.

    • DELETE

      public static final ModificationType DELETE
      Delete the values listed in the modification from the attribute. If no values are listed, or if all current values of the attribute are listed, the entire attribute is removed.

    • REPLACE

      public static final ModificationType REPLACE
      Replace all existing values of the attribute with the new values listed in the modification, creating the attribute if it did not already exist. A replace with no listed values will delete the entire attribute if it exists, and it is ignored if the attribute does not exist.

    • INCREMENT

      public static final ModificationType INCREMENT
      Increment all existing values of the attribute by the amount specified in the modification value.

  • Method Details

    • valueOf

      public static ModificationType valueOf(int intValue)
      Returns the modification change type having the specified integer value as defined in RFC 4511 section 4.6.
      Parameters:
      intValue - The integer value of the modification change type.
      Returns:
      The modification change type, or null if there was no modification change type associated with intValue.

    • values

      public static List<ModificationType> values()
      Returns an unmodifiable list containing the set of available modification change types indexed on their integer value as defined in RFC 4511 section 4.6.
      Returns:
      An unmodifiable list containing the set of available modification change types.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • intValue

      public int intValue()
      Returns the integer value of this modification change type as defined in RFC 4511 section 4.6.
      Returns:
      The integer value of this modification change type.

    • asEnum

      public ModificationType.Enum asEnum()
      Returns the enum equivalent for this modification type.
      Returns:
      The enum equivalent for this modification type when a known mapping exists, or ModificationType.Enum.UNKNOWN if this is an unknown modification type.

    • toString

      public String toString()
      Returns the string representation of this modification change type.
      Overrides:
      toString in class Object
      Returns:
      The string representation of this modification change type.