com.bazaarvoice.jackson.rison
Enum RisonGenerator.Feature

java.lang.Object
  java.lang.Enum<RisonGenerator.Feature>
      com.bazaarvoice.jackson.rison.RisonGenerator.Feature

All Implemented Interfaces:

Serializable, Comparable<RisonGenerator.Feature>

Enclosing class:

RisonGenerator

public static enum RisonGenerator.Feature
extends Enum<RisonGenerator.Feature>

Enumeration that defines all configurable features for Rison generators.

Enum Constant Summary

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

static int	collectDefaults() Method that calculates bit set (flags) of all features that are enabled by default.
boolean	enabledByDefault()
int	getMask()
static RisonGenerator.Feature	valueOf(String name) Returns the enum constant of this type with the specified name.
static RisonGenerator.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 RisonGenerator.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 RisonGenerator.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 RisonGenerator.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 (RisonGenerator.Feature c : RisonGenerator.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 RisonGenerator.Feature 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

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()