ITimestamp.Format (CSS Core API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.csstudio.data.values
Enum ITimestamp.Format

java.lang.Object
  java.lang.Enum<ITimestamp.Format>
      org.csstudio.data.values.ITimestamp.Format

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<ITimestamp.Format>

Enclosing interface:: ITimestamp

public static enum ITimestamp.Format
extends java.lang.Enum<ITimestamp.Format>
extends java.lang.Enum<ITimestamp.Format>

Format specifier.

See Also:: ITimestamp#format()

Enum Constant Summary
`Date` Format to "YYYY/MM/DD".
`DateTime` Format to "YYYY/MM/DD HH:MM".
`DateTimeSeconds` Format to "YYYY/MM/DD HH:MM:SS".
`Full` Format to "YYYY/MM/DD HH:MM:SS.000000000".

Method Summary
`static ITimestamp.Format`	`fromOrdinal(int ordinal)` Obtain `ITimestamp.Format` for given ordinal.
`static ITimestamp.Format`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ITimestamp.Format[]`	`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

Date

public static final ITimestamp.Format Date

Format to "YYYY/MM/DD".

DateTime

public static final ITimestamp.Format DateTime

Format to "YYYY/MM/DD HH:MM".

DateTimeSeconds

public static final ITimestamp.Format DateTimeSeconds

Format to "YYYY/MM/DD HH:MM:SS".

Full

public static final ITimestamp.Format Full

Format to "YYYY/MM/DD HH:MM:SS.000000000".

Method Detail

values

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

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

valueOf

public static ITimestamp.Format 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

fromOrdinal

public static final ITimestamp.Format fromOrdinal(int ordinal)

Obtain ITimestamp.Format for given ordinal.

Parameters:: ordinal - Should be one of the Format.XX.ordinal() codes.
Returns:: Format for the given ordinal.