com.bazaarvoice.jackson.rison

Enum RisonParser.Feature

java.lang.Object

java.lang.Enum<RisonParser.Feature>

com.bazaarvoice.jackson.rison.RisonParser.Feature

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RisonParser.Feature>

Enclosing class:

RisonParser

public static enum RisonParser.Feature
extends java.lang.Enum<RisonParser.Feature>

Enumeration that defines all configurable features for Rison parsers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
A_RISON Whether to assume that the top-level value being encoded is an array, and therefore to omit the containing '!(' and ')'.
O_RISON Whether to assume that the top-level value being encoded is an object, and therefore to omit the containing '(' and ')'.

Method Summary

Modifier and Type	Method and Description
static int	collectDefaults() Method that calculates bit set (flags) of all features that are enabled by default.
boolean	enabledByDefault()
int	getMask()
static RisonParser.Feature	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RisonParser.Feature[]	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

O_RISON

public static final RisonParser.Feature O_RISON

Whether to assume that the top-level value being encoded is an object, and therefore to omit the containing '(' and ')'.

Default setting is false.

A_RISON

public static final RisonParser.Feature A_RISON

Whether to assume that the top-level value being encoded is an array, and therefore to omit the containing '!(' and ')'.

Default setting is false.

Method Detail

values

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

Returns:

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

valueOf

public static RisonParser.Feature 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

collectDefaults

public static int collectDefaults()

Method that calculates bit set (flags) of all features that are enabled by default.

enabledByDefault

public boolean enabledByDefault()

getMask

public int getMask()