com.squareup.square

Enum Environment

java.lang.Object

java.lang.Enum<Environment>

com.squareup.square.Environment

All Implemented Interfaces:

Serializable, Comparable<Environment>

public enum Environment
extends Enum<Environment>

Environment to be used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM
PRODUCTION
SANDBOX

Method Summary

Modifier and Type	Method and Description
static Environment	constructFromString(String toConvert) Returns the enum member associated with the given string value.
static Environment	fromString(String toConvert) Returns the enum member associated with the given string value.
String	toString() Get string representation of this enum.
static List<String>	toValue(List<Environment> toConvert) Convert list of Environment values to list of string values.
String	value() Returns the string value associated with the enum member.
static Environment	valueOf(String name) Returns the enum constant of this type with the specified name.
static Environment[]	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

PRODUCTION

public static final Environment PRODUCTION

SANDBOX

public static final Environment SANDBOX

CUSTOM

public static final Environment CUSTOM

Method Detail

values

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

Returns:

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

valueOf

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

constructFromString

public static Environment constructFromString(String toConvert)
                                       throws IOException

Returns the enum member associated with the given string value.

Parameters:

toConvert - String value to get enum member.

Returns:

The enum member against the given string value.

Throws:

IOException - when provided value is not mapped to any enum member.

fromString

public static Environment fromString(String toConvert)

Returns the enum member associated with the given string value.

Parameters:

toConvert - String value to get enum member.

Returns:

The enum member against the given string value.

value

public String value()

Returns the string value associated with the enum member.

Returns:

The string value against enum member.

toString

public String toString()

Get string representation of this enum.

Overrides:

toString in class Enum<Environment>

toValue

public static List<String> toValue(List<Environment> toConvert)

Convert list of Environment values to list of string values.

Parameters:

toConvert - The list of Environment values to convert.

Returns:

List of representative string values.