agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r3.jar)

Enum PathPrimitiveRemoveLocation

java.lang.Object

java.lang.Enum<PathPrimitiveRemoveLocation>

agi.foundation.graphics.advanced.PathPrimitiveRemoveLocation

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PathPrimitiveRemoveLocation>

public enum PathPrimitiveRemoveLocation
extends Enum<PathPrimitiveRemoveLocation>
implements Enumeration

Represents the location of a point to be removed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REMOVE_LOCATION_BACK Remove from the back of the line.
REMOVE_LOCATION_FRONT Remove from the front of the line.

Method Summary

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

REMOVE_LOCATION_FRONT

public static final PathPrimitiveRemoveLocation REMOVE_LOCATION_FRONT

Remove from the front of the line.

REMOVE_LOCATION_BACK

public static final PathPrimitiveRemoveLocation REMOVE_LOCATION_BACK

Remove from the back of the line.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.