com.sigio.json

Enum JSONLiteral

java.lang.Object

java.lang.Enum<JSONLiteral>

com.sigio.json.JSONLiteral

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JSONLiteral>

public enum JSONLiteral
extends java.lang.Enum<JSONLiteral>

Enum for the allowed JSON literals as defined in RFC4627.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE The false literal string.
NULL The null literal string.
TRUE The true literal string.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.String str) Check if a passed in string matches the literal's value.
static JSONLiteral	fromString(java.lang.String str) Get a JSONLiteral from a string.
java.lang.String	toString() Returns a string representation of the object.
java.lang.String	value() Get our literal value.
static JSONLiteral	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JSONLiteral[]	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

NULL

public static final JSONLiteral NULL

The null literal string.

TRUE

public static final JSONLiteral TRUE

The true literal string. Our implementation returns this instead of Boolean.TRUE.

FALSE

public static final JSONLiteral FALSE

The false literal string. Our implementation returns this instead of Boolean.FALSE.

Method Detail

values

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

Returns:

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

valueOf

public static JSONLiteral valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public java.lang.String value()

Get our literal value.

Returns:

string with the literal JSON value

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Enum<JSONLiteral>

Returns:

String of the literal JSON value

equals

public boolean equals(java.lang.String str)

Check if a passed in string matches the literal's value.

Parameters:

str - string to check

Returns:

true if the string matches, false if not

fromString

public static JSONLiteral fromString(java.lang.String str)
                              throws JSONException

Get a JSONLiteral from a string.

Parameters:

str - string containing a JSON literal value

Returns:

the JSONLiteral whose value matches the string

Throws:

JSONException - if the string does not match a JSON literal value