org.springframework.hateoas.alps

Enum Format

java.lang.Object

java.lang.Enum<Format>

org.springframework.hateoas.alps.Format

All Implemented Interfaces:

Serializable, Comparable<Format>

public enum Format
extends Enum<Format>

Enum for all ALPS doc formats.

Since:

0.15

Author:

Oliver Gierke, Greg Turnquist

See Also:

http://alps.io/spec/#prop-format

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCIIDOC
HTML
TEXT

Method Summary

Modifier and Type	Method and Description
String	toString()
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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEXT

public static final Format TEXT

HTML

public static final Format HTML

ASCIIDOC

public static final Format ASCIIDOC

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

toString

public String toString()

Overrides:

toString in class Enum<Format>