burrows.api.finance.model

Enum Format

java.lang.Object

java.lang.Enum<Format>

burrows.api.finance.model.Format

All Implemented Interfaces:

Serializable, Comparable<Format>

public enum Format
extends Enum<Format>

An enumeration that represents the formats that the API supports.

Since:

0.0.1

Author:

Jared Burrows

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT
JSON
XML

Method Summary

Modifier and Type	Method and Description
static Format	fromInt(int intValue) Returns the integer value of this enum instance.
static Format	fromString(String stringValue) Returns the enum instance for the specified string.
int	getIntValue() Returns the integer value of this enum instance.
String	getStringValue() Returns the underlying stringValue of this instance.
static Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static Format[]	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

DEFAULT

public static final Format DEFAULT

XML

public static final Format XML

JSON

public static final Format JSON

Method Detail

values

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

Returns:

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

valueOf

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

getIntValue

public int getIntValue()

Returns the integer value of this enum instance.

Returns:

the integer value of this enum instance.

Since:

0.0.1

See Also:

fromInt(int)

getStringValue

public String getStringValue()

Returns the underlying stringValue of this instance.

Returns:

the underlying stringValue of this instance.

Since:

0.0.1

See Also:

fromString(String)

fromInt

public static Format fromInt(int intValue)

Returns the integer value of this enum instance.

Parameters:

intValue - the integer value to determine the matching enum instance for.

Returns:

the enum instance for the specified int value, or null if there is no match.

Since:

0.0.1

See Also:

getIntValue()

fromString

public static Format fromString(String stringValue)

Returns the enum instance for the specified string.

Parameters:

stringValue - the string value to determine the matching enum instance for.

Returns:

the enum instance for the specified string, or null if there is no match.

Since:

0.0.1

See Also:

getStringValue()