com.unboundid.ldap.sdk.unboundidds.controls
Enum SuppressType

java.lang.Object
  extended by java.lang.Enum<SuppressType>
      extended by com.unboundid.ldap.sdk.unboundidds.controls.SuppressType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SuppressType>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum SuppressType
extends java.lang.Enum<SuppressType>

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This enum defines the set of operational update types that may be suppressed by the suppress operational attribute update request control.


Enum Constant Summary
LAST_ACCESS_TIME
          The value that indicates that last access time updates should be suppressed.
LAST_LOGIN_IP
          The value that indicates that last login IP address updates should be suppressed.
LAST_LOGIN_TIME
          The value that indicates that last login time updates should be suppressed.
LASTMOD
          The value that indicates that lastmod updates (creatorsName, createTimestamp, modifiersName, modifyTimestamp) should be suppressed.
 
Method Summary
 int intValue()
          Retrieves the integer value for this suppress type value.
static SuppressType valueOf(int intValue)
          Retrieves the suppress type value for the provided integer value.
static SuppressType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SuppressType[] 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

LAST_ACCESS_TIME

public static final SuppressType LAST_ACCESS_TIME
The value that indicates that last access time updates should be suppressed.


LAST_LOGIN_TIME

public static final SuppressType LAST_LOGIN_TIME
The value that indicates that last login time updates should be suppressed.


LAST_LOGIN_IP

public static final SuppressType LAST_LOGIN_IP
The value that indicates that last login IP address updates should be suppressed.


LASTMOD

public static final SuppressType LASTMOD
The value that indicates that lastmod updates (creatorsName, createTimestamp, modifiersName, modifyTimestamp) should be suppressed.

Method Detail

values

public static SuppressType[] 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 (SuppressType c : SuppressType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SuppressType 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 suppress type value.

Returns:
The integer value for this suppress type value.

valueOf

public static SuppressType valueOf(int intValue)
Retrieves the suppress type value for the provided integer value.

Parameters:
intValue - The integer value for the suppress type value to retrieve.
Returns:
The suppress type value that corresponds to the provided integer value, or null if there is no corresponding suppress type value.