au.gov.nehta.vendorlibrary.mdm.enums

Enum FormatTypes

java.lang.Object

java.lang.Enum<FormatTypes>

au.gov.nehta.vendorlibrary.mdm.enums.FormatTypes

All Implemented Interfaces:

Serializable, Comparable<FormatTypes>

public enum FormatTypes
extends Enum<FormatTypes>

FormatTypes Enum of format strings used with String.Format().

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR_HEADER Structure of error.

Method Summary

Modifier and Type	Method and Description
String	getStructure() Retrieve the relevant string format.
static FormatTypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static FormatTypes[]	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

ERROR_HEADER

public static final FormatTypes ERROR_HEADER

Structure of error.

Method Detail

values

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

Returns:

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

valueOf

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

getStructure

public String getStructure()

Retrieve the relevant string format.

Returns:

String.