Enum ContentSyncState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ContentSyncState>

    public enum ContentSyncState
    extends java.lang.Enum<ContentSyncState>
    This enum defines the synchronization states for entries returned with the content synchronization state control. See the documentation for the ContentSyncRequestControl class for more information about using the content synchronization operation.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADD
      Indicates that the associated entry or reference was just created by an add or modify DN operation.
      DELETE
      Indicates that the associated entry or reference was just removed by a delete or modify DN operation.
      MODIFY
      Indicates that the associated entry or reference was just updated by a modify or modify DN operation.
      PRESENT
      Indicates that the associated entry or reference was already present in the server when the synchronization was initiated.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ContentSyncState forName​(java.lang.String name)
      Retrieves the content synchronization state with the specified name.
      int intValue()
      Retrieves the integer value for this synchronization state.
      static ContentSyncState valueOf​(int intValue)
      Retrieves the content synchronization state with the specified integer value.
      static ContentSyncState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ContentSyncState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • PRESENT

        public static final ContentSyncState PRESENT
        Indicates that the associated entry or reference was already present in the server when the synchronization was initiated.
      • ADD

        public static final ContentSyncState ADD
        Indicates that the associated entry or reference was just created by an add or modify DN operation.
      • MODIFY

        public static final ContentSyncState MODIFY
        Indicates that the associated entry or reference was just updated by a modify or modify DN operation.
      • DELETE

        public static final ContentSyncState DELETE
        Indicates that the associated entry or reference was just removed by a delete or modify DN operation.
    • Method Detail

      • values

        public static ContentSyncState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ContentSyncState c : ContentSyncState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ContentSyncState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • intValue

        public int intValue()
        Retrieves the integer value for this synchronization state.
        Returns:
        The integer value for this synchronization state.
      • valueOf

        public static ContentSyncState valueOf​(int intValue)
        Retrieves the content synchronization state with the specified integer value.
        Parameters:
        intValue - The integer value for which to retrieve the corresponding synchronization state.
        Returns:
        The content synchronization state with the specified integer value, or null if the given value does not correspond with any defined state.
      • forName

        public static ContentSyncState forName​(java.lang.String name)
        Retrieves the content synchronization state with the specified name.
        Parameters:
        name - The name of the content synchronization state to retrieve. It must not be null.
        Returns:
        The requested content synchronization state, or null if no such state is defined.