agi.foundation.graphics.imaging

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

Enum FlipAxis

java.lang.Object

java.lang.Enum<FlipAxis>

agi.foundation.graphics.imaging.FlipAxis

All Implemented Interfaces:

Enumeration, Serializable, Comparable<FlipAxis>

public enum FlipAxis
extends Enum<FlipAxis>
implements Enumeration

The axis on which a raster will be flipped.

See Also:

FlipFilter, agi.foundation.graphics.imaging.Raster#flip()

Enum Constant Summary

Enum Constants

Enum Constant and Description
HORIZONTAL The horizontal axis.
VERTICAL The vertical axis.

Method Summary

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

HORIZONTAL

public static final FlipAxis HORIZONTAL

The horizontal axis.

VERTICAL

public static final FlipAxis VERTICAL

The vertical axis.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.