com.esri.core.internal.value
Enum RampDefinition.Algorithm

java.lang.Object
  java.lang.Enum<RampDefinition.Algorithm>
      com.esri.core.internal.value.RampDefinition.Algorithm

All Implemented Interfaces:

Serializable, Comparable<RampDefinition.Algorithm>

Enclosing class:

RampDefinition

public static enum RampDefinition.Algorithm
extends Enum<RampDefinition.Algorithm>

Defines an algorithm used by a map server to generate a color ramp given starting and ending colors. One of:

HSV

CIELab

LabLCh

Enum Constant Summary

CIELab

HSV

LabLCh

Method Summary

static RampDefinition.Algorithm	fromString(String v) Gets an alogorithm from a string.
String	getValue() Gets the value as a string converted to the arcobjects enum equivalent.
String	toString()
static RampDefinition.Algorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static RampDefinition.Algorithm[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HSV

public static final RampDefinition.Algorithm HSV

CIELab

public static final RampDefinition.Algorithm CIELab

LabLCh

public static final RampDefinition.Algorithm LabLCh

Method Detail

values

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

Returns:

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

valueOf

public static RampDefinition.Algorithm 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 String getValue()

Gets the value as a string converted to the arcobjects enum equivalent.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Enum<RampDefinition.Algorithm>

fromString

public static RampDefinition.Algorithm fromString(String v)

Gets an alogorithm from a string.

Parameters:

v - the string

Returns:

the alogorithm