Package com.unboundid.ldap.sdk.controls
Enum ContentSyncInfoType
- java.lang.Object
-
- java.lang.Enum<ContentSyncInfoType>
-
- com.unboundid.ldap.sdk.controls.ContentSyncInfoType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ContentSyncInfoType>
public enum ContentSyncInfoType extends java.lang.Enum<ContentSyncInfoType>
This enum defines the synchronization states for entries returned with the content synchronization state control. See the documentation for theContentSyncRequestControl
class for more information about using the content synchronization operation.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description NEW_COOKIE
Indicates that the associated content synchronization info response only provides a new state cookie.REFRESH_DELETE
Indicates that the associated content synchronization info response is used to indicate that a delete phase has ended.REFRESH_PRESENT
Indicates that the associated content synchronization info response is used to indicate that a present phase has ended.SYNC_ID_SET
Indicates that the associated content synchronization info response is used to provide information about multiple entries which have been deleted or multiple entries which have remained unchanged.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ContentSyncInfoType
forName(java.lang.String name)
Retrieves the content synchronization info type with the specified name.byte
getType()
Retrieves the BER type for this synchronization info type value.static ContentSyncInfoType
valueOf(byte type)
Retrieves the content synchronization info type with the specified BER type.static ContentSyncInfoType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ContentSyncInfoType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NEW_COOKIE
public static final ContentSyncInfoType NEW_COOKIE
Indicates that the associated content synchronization info response only provides a new state cookie.
-
REFRESH_DELETE
public static final ContentSyncInfoType REFRESH_DELETE
Indicates that the associated content synchronization info response is used to indicate that a delete phase has ended.
-
REFRESH_PRESENT
public static final ContentSyncInfoType REFRESH_PRESENT
Indicates that the associated content synchronization info response is used to indicate that a present phase has ended.
-
SYNC_ID_SET
public static final ContentSyncInfoType SYNC_ID_SET
Indicates that the associated content synchronization info response is used to provide information about multiple entries which have been deleted or multiple entries which have remained unchanged.
-
-
Method Detail
-
values
public static ContentSyncInfoType[] 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 (ContentSyncInfoType c : ContentSyncInfoType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ContentSyncInfoType 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 namejava.lang.NullPointerException
- if the argument is null
-
getType
public byte getType()
Retrieves the BER type for this synchronization info type value.- Returns:
- The BER type for this synchronization info type value.
-
valueOf
public static ContentSyncInfoType valueOf(byte type)
Retrieves the content synchronization info type with the specified BER type.- Parameters:
type
- The BER type of the content synchronization info type value to retrieve.- Returns:
- The content synchronization info value with the specified BER
type, or
null
if the given value does not correspond with any defined type.
-
forName
public static ContentSyncInfoType forName(java.lang.String name)
Retrieves the content synchronization info type with the specified name.- Parameters:
name
- The name of the content synchronization info type to retrieve. It must not benull
.- Returns:
- The requested content sync info type, or
null
if no such type is defined.
-
-