com.mebigfatguy.pixelle
Enum IndexOutOfBoundsOption

java.lang.Object
  java.lang.Enum<IndexOutOfBoundsOption>
      com.mebigfatguy.pixelle.IndexOutOfBoundsOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexOutOfBoundsOption>

public enum IndexOutOfBoundsOption
extends java.lang.Enum<IndexOutOfBoundsOption>

an enum that represents what to do when an index specified is outside the coordinates of the source bitmap.

Enum Constant Summary

BorderColor
use the closest border color

SpecifiedColor
use the specified color

WrapColor
calculate a new index using the modulus function of the width or height

Method Summary

java.awt.Color	getColor() retrieves the color that is used for when the enum is 'SpecifiedColor'
void	setColor(java.awt.Color clr) sets the color that is used for when the enum is 'SpecifiedColor'
static IndexOutOfBoundsOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IndexOutOfBoundsOption[]	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

SpecifiedColor

public static final IndexOutOfBoundsOption SpecifiedColor

use the specified color

BorderColor

public static final IndexOutOfBoundsOption BorderColor

use the closest border color

WrapColor

public static final IndexOutOfBoundsOption WrapColor

calculate a new index using the modulus function of the width or height

Method Detail

values

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

Returns:

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

valueOf

public static IndexOutOfBoundsOption 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

getColor

public java.awt.Color getColor()

retrieves the color that is used for when the enum is 'SpecifiedColor'

Returns:

the specified color

setColor

public void setColor(java.awt.Color clr)

sets the color that is used for when the enum is 'SpecifiedColor'

Parameters:

clr - the specified color