com.io7m.kstructural.frontend

Enum KSInputFormat

java.lang.Object

java.lang.Enum<KSInputFormat>

com.io7m.kstructural.frontend.KSInputFormat

All Implemented Interfaces:

Serializable, Comparable<KSInputFormat>

public enum KSInputFormat
extends Enum<KSInputFormat>

The supported input formats for documents.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KS_INPUT_CANONICAL The canonical s-expression format.
KS_INPUT_IMPERATIVE The imperative s-expression format.
KS_INPUT_XML The XML format.

Method Summary

Modifier and Type	Method and Description
String	getName()
String	toString()
static KSInputFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static KSInputFormat[]	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

KS_INPUT_CANONICAL

public static final KSInputFormat KS_INPUT_CANONICAL

The canonical s-expression format.

KS_INPUT_IMPERATIVE

public static final KSInputFormat KS_INPUT_IMPERATIVE

The imperative s-expression format.

KS_INPUT_XML

public static final KSInputFormat KS_INPUT_XML

The XML format.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Returns:

The name of the format

toString

public String toString()

Overrides:

toString in class Enum<KSInputFormat>