agi.foundation.platforms.advanced

(agi.foundation.platforms.graphics-2024r1.jar)

Enum DisplayConditionType

java.lang.Object

java.lang.Enum<DisplayConditionType>

agi.foundation.platforms.advanced.DisplayConditionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<DisplayConditionType>

public enum DisplayConditionType
extends Enum<DisplayConditionType>
implements Enumeration

Indicates the type of DisplayCondition that will be created by DisplayParametersHelper.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BATCH The DistanceDisplayCondition will be created separately so that it can be used in batch primitives that support a distance display condition per item.
COMPOSITE All display conditions will be created in a single CompositeDisplayCondition.

Method Summary

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

COMPOSITE

public static final DisplayConditionType COMPOSITE

All display conditions will be created in a single CompositeDisplayCondition. Use this setting when a primitive represents a single service provider.

BATCH

public static final DisplayConditionType BATCH

The DistanceDisplayCondition will be created separately so that it can be used in batch primitives that support a distance display condition per item. No ConstantDisplayCondition will be created. The remaining display conditions will still be created as part of a single CompositeDisplayCondition.

Method Detail

values

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

Returns:

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

valueOf

public static DisplayConditionType 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 DisplayConditionType 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 DisplayConditionType getDefault()

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

Returns:

The default enum constant.