agi.foundation.stk

(agi.foundation.models-2024r2.jar)

Enum StkPatternFileVersion

java.lang.Object

java.lang.Enum<StkPatternFileVersion>

agi.foundation.stk.StkPatternFileVersion

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StkPatternFileVersion>

public enum StkPatternFileVersion
extends Enum<StkPatternFileVersion>
implements Enumeration

Indicates the possible versions of an STK pattern file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
UNKNOWN Version which corresponds to an unrecognized version stamp in an STK pattern file.
V20 Version 2.0 format which corresponds to a stk.v.2.0 version stamp in an STK pattern file.
V30 Version 3.0 format which corresponds to a stk.v.3.0 version stamp in an STK pattern file.
V43 Version 4.3 format which corresponds to a stk.v.4.3 version stamp in an STK pattern file.
V60 Version 6.0 format which corresponds to a stk.v.6.0 version stamp in an STK pattern file.

Method Summary

Modifier and Type	Method and Description
static StkPatternFileVersion	getDefault() Get the enum constant that is considered to be the default.
static StkPatternFileVersion	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static StkPatternFileVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static StkPatternFileVersion[]	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

UNKNOWN

public static final StkPatternFileVersion UNKNOWN

Version which corresponds to an unrecognized version stamp in an STK pattern file.

V20

public static final StkPatternFileVersion V20

Version 2.0 format which corresponds to a stk.v.2.0 version stamp in an STK pattern file.

V30

public static final StkPatternFileVersion V30

Version 3.0 format which corresponds to a stk.v.3.0 version stamp in an STK pattern file.

V43

public static final StkPatternFileVersion V43

Version 4.3 format which corresponds to a stk.v.4.3 version stamp in an STK pattern file.

V60

public static final StkPatternFileVersion V60

Version 6.0 format which corresponds to a stk.v.6.0 version stamp in an STK pattern file.

Method Detail

values

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

Returns:

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

valueOf

public static StkPatternFileVersion valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static StkPatternFileVersion getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static StkPatternFileVersion getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.