Enum FileRetentionTaskTimestampFormat
- java.lang.Object
-
- java.lang.Enum<FileRetentionTaskTimestampFormat>
-
- com.unboundid.ldap.sdk.unboundidds.tasks.FileRetentionTaskTimestampFormat
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<FileRetentionTaskTimestampFormat>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum FileRetentionTaskTimestampFormat extends java.lang.Enum<FileRetentionTaskTimestampFormat>
This enum defines the set of allowed timestamp formats for use in conjunction with the file retention task.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description GENERALIZED_TIME_UTC_WITH_MILLISECONDS
The timestamp format that uses the generalized time format in the UTC time zone (with the 'Z' time zone indicator) with millisecond-level precision (e.g., "20180102123456.789Z").GENERALIZED_TIME_UTC_WITH_MINUTES
The timestamp format that uses the generalized time format in the UTC time zone (with the 'Z' time zone indicator) with minute-level precision (e.g., "201801021234Z").GENERALIZED_TIME_UTC_WITH_SECONDS
The timestamp format that uses the generalized time format in the UTC time zone (with the 'Z' time zone indicator) with second-level precision (e.g., "20180102123456Z").LOCAL_DATE
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with day-level precision (e.g., "20180102").LOCAL_TIME_WITH_MILLISECONDS
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with millisecond-level precision (e.g., "20180102123456.789").LOCAL_TIME_WITH_MINUTES
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with minute-level precision (e.g., "201801021234").LOCAL_TIME_WITH_SECONDS
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with second-level precision (e.g., "20180102123456").
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FileRetentionTaskTimestampFormat
forName(java.lang.String name)
Retrieves the timestamp format value with the specified name.java.lang.String
getRegexString()
Retrieves a regular expression string that can be used to match timestamps in this format.java.lang.String
getSimpleDateFormatString()
Retrieves a format string that can be used to create aSimpleDateFormat
object capable of parsing timestamps in this format.boolean
isInUTCTimeZone()
Indicates whether the timestamp format should use the UTC time zone rather than the JVM's default time zone.static FileRetentionTaskTimestampFormat
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static FileRetentionTaskTimestampFormat[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
GENERALIZED_TIME_UTC_WITH_MILLISECONDS
public static final FileRetentionTaskTimestampFormat GENERALIZED_TIME_UTC_WITH_MILLISECONDS
The timestamp format that uses the generalized time format in the UTC time zone (with the 'Z' time zone indicator) with millisecond-level precision (e.g., "20180102123456.789Z").
-
GENERALIZED_TIME_UTC_WITH_SECONDS
public static final FileRetentionTaskTimestampFormat GENERALIZED_TIME_UTC_WITH_SECONDS
The timestamp format that uses the generalized time format in the UTC time zone (with the 'Z' time zone indicator) with second-level precision (e.g., "20180102123456Z").
-
GENERALIZED_TIME_UTC_WITH_MINUTES
public static final FileRetentionTaskTimestampFormat GENERALIZED_TIME_UTC_WITH_MINUTES
The timestamp format that uses the generalized time format in the UTC time zone (with the 'Z' time zone indicator) with minute-level precision (e.g., "201801021234Z").
-
LOCAL_TIME_WITH_MILLISECONDS
public static final FileRetentionTaskTimestampFormat LOCAL_TIME_WITH_MILLISECONDS
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with millisecond-level precision (e.g., "20180102123456.789").
-
LOCAL_TIME_WITH_SECONDS
public static final FileRetentionTaskTimestampFormat LOCAL_TIME_WITH_SECONDS
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with second-level precision (e.g., "20180102123456").
-
LOCAL_TIME_WITH_MINUTES
public static final FileRetentionTaskTimestampFormat LOCAL_TIME_WITH_MINUTES
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with minute-level precision (e.g., "201801021234").
-
LOCAL_DATE
public static final FileRetentionTaskTimestampFormat LOCAL_DATE
The timestamp format that uses a numeric form at in the local time zone (with no time zone indicator) with day-level precision (e.g., "20180102").
-
-
Method Detail
-
values
public static FileRetentionTaskTimestampFormat[] 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 (FileRetentionTaskTimestampFormat c : FileRetentionTaskTimestampFormat.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FileRetentionTaskTimestampFormat 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
-
isInUTCTimeZone
public boolean isInUTCTimeZone()
Indicates whether the timestamp format should use the UTC time zone rather than the JVM's default time zone.- Returns:
true
if the timestamp format should use the UTC time zone, orfalse
if it should use the JVM's default time zone (which itself may or may not be the UTC time zone).
-
getSimpleDateFormatString
@NotNull public java.lang.String getSimpleDateFormatString()
Retrieves a format string that can be used to create aSimpleDateFormat
object capable of parsing timestamps in this format.- Returns:
- A format string that can be used to create a
SimpleDateFormat
object capable of parsing timestamps in this format.
-
getRegexString
@NotNull public java.lang.String getRegexString()
Retrieves a regular expression string that can be used to match timestamps in this format. The returned string will be surrounded by parentheses so that it can act as a capture group.- Returns:
- A regular expression string that can be used to match timestamps in this format.
-
forName
@Nullable public static FileRetentionTaskTimestampFormat forName(@NotNull java.lang.String name)
Retrieves the timestamp format value with the specified name.- Parameters:
name
- The name of the timestamp format value to retrieve.- Returns:
- The timestamp format value with the specified name, or
null
if there is no value with that name.
-
-