com.pb.routing.enums

Enum BandingStyle

java.lang.Object

java.lang.Enum<BandingStyle>

com.pb.routing.enums.BandingStyle

All Implemented Interfaces:

Serializable, Comparable<BandingStyle>

public enum BandingStyle
extends Enum<BandingStyle>

Banding Styles are the types of multiple distance bands that can be displayed based on multiple costs.

There are two types of BandingStyles supported for travel boundary - DONUT and ENCOMPASSING

Enum Constant Summary

Enum Constants

Enum Constant and Description
DONUT With this banding style each boundary is determined by subtracting out the next smallest boundary.
ENCOMPASSING With this banding style each boundary is determined independent of all others.

Method Summary

Modifier and Type	Method and Description
static BandingStyle	getStyle(String value) Converts the specified value to corresponding BandingStyle choice.
String	getValue() Returns the value of BandingStyle.
static BandingStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static BandingStyle[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DONUT

public static final BandingStyle DONUT

With this banding style each boundary is determined by subtracting out the next smallest boundary. This is also the default banding style.

ENCOMPASSING

public static final BandingStyle ENCOMPASSING

With this banding style each boundary is determined independent of all others.

Method Detail

values

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

Returns:

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

valueOf

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

Returns the value of BandingStyle.

Returns:

A String, the value of BandingStyle.

getStyle

public static BandingStyle getStyle(String value)

Converts the specified value to corresponding BandingStyle choice.

For e.g. BandingStyle.getStyle("donut") gives BandingStyle.DONUT

Parameters:

value - A String, BandingStyle value.

Returns:

Corresponding BandingStyle choice.