org.glassfish.jersey.media.json
Class JsonConfiguration

java.lang.Object
  org.glassfish.jersey.media.json.JsonConfiguration

public class JsonConfiguration
extends Object

An immutable configuration of JSON notation and options. JsonConfiguration instance can be used for configuring the JSON notation on JsonJaxbContext.

Author:

Jakub Podlesak

Nested Class Summary

static class	JsonConfiguration.Builder Builder class for constructing JsonConfiguration options
static class	JsonConfiguration.MappedBuilder Builder class for constructing JsonConfiguration options for the JsonConfiguration.Notation.MAPPED convention.
static class	JsonConfiguration.MappedJettisonBuilder Builder class for constructing JsonConfiguration options for the JsonConfiguration.Notation.MAPPED_JETTISON convention.
static class	JsonConfiguration.NaturalBuilder Builder class for constructing JsonConfiguration options for the JsonConfiguration.Notation.NATURAL convention.
static class	JsonConfiguration.Notation Enumeration of supported JSON notations.

Field Summary

static JsonConfiguration

DEFAULT The default JsonConfiguration uses JsonConfiguration.Notation.MAPPED notation with root unwrapping option set to true.

Method Summary

static JsonConfiguration.Builder	badgerFish() A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.BADGERFISH JSON notation.
static JsonConfiguration.Builder	copyBuilder(JsonConfiguration jc)
static JsonConfiguration	createJSONConfigurationWithFormatted(JsonConfiguration c, boolean formatted) A static method for obtaining JsonConfiguration instance with humanReadableFormatting set according to formatted parameter.
static JsonConfiguration	createJSONConfigurationWithRootUnwrapping(JsonConfiguration c, boolean rootUnwrapping) A static method for obtaining JsonConfiguration instance with rootUnwrapping set according to formatted parameter.
Collection<String>	getArrays() Returns JSON array names property This property is valid for the JsonConfiguration.Notation.MAPPED notation only.
Collection<String>	getAttributeAsElements() Returns names of attributes, which will be handled as elements This property is valid for the JsonConfiguration.Notation.MAPPED notation only.
Collection<String>	getNonStrings() Returns names of JSON objects, which will be serialized out as non-strings, i.e.
JsonConfiguration.Notation	getNotation() Returns JSON notation selected for this configuration
Character	getNsSeparator() Returns XML namespace separator, which is used when constructing JSON identifiers for XML elements/attributes in other than default namespace This property is valid for the JsonConfiguration.Notation.MAPPED notation only.
Map<String,String>	getXml2JsonNs() Returns a map for XML to JSON namespace mapping This property is valid for the JsonConfiguration.Notation.MAPPED notation only.
boolean	isHumanReadableFormatting() Says if the output JSON will be formatted with new-line characters and indentation so that it is easy to read for people.
boolean	isRootUnwrapping() Says if the root element will be stripped off This property is valid for the JsonConfiguration.Notation.MAPPED and JsonConfiguration.Notation.NATURAL notations.
boolean	isUsingPrefixesAtNaturalAttributes() Says if the JSON names corresponding to XML attributes should use a '@' prefix.
static JsonConfiguration.MappedBuilder	mapped() A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.MAPPED JSON notation.
static JsonConfiguration.MappedJettisonBuilder	mappedJettison() A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.MAPPED_JETTISON JSON notation.
static JsonConfiguration.NaturalBuilder	natural() A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.NATURAL JSON notation.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT

public static final JsonConfiguration DEFAULT

The default JsonConfiguration uses JsonConfiguration.Notation.MAPPED notation with root unwrapping option set to true.

Method Detail

createJSONConfigurationWithFormatted

public static JsonConfiguration createJSONConfigurationWithFormatted(JsonConfiguration c,
                                                                     boolean formatted)
                                                              throws IllegalArgumentException

A static method for obtaining JsonConfiguration instance with humanReadableFormatting set according to formatted parameter.

Parameters:

c - original instance of JsonConfiguration, can't be null

formatted -

Returns:

copy of provided JsonConfiguration with humanReadableFormatting set to formatted.

Throws:

IllegalArgumentException - when provided JsonConfiguration is null.

createJSONConfigurationWithRootUnwrapping

public static JsonConfiguration createJSONConfigurationWithRootUnwrapping(JsonConfiguration c,
                                                                          boolean rootUnwrapping)
                                                                   throws IllegalArgumentException

A static method for obtaining JsonConfiguration instance with rootUnwrapping set according to formatted parameter.

Parameters:

c - original instance of JsonConfiguration, can't be null

rootUnwrapping -

Returns:

copy of provided JsonConfiguration with humanReadableFormatting set to formatted.

Throws:

IllegalArgumentException - when provided JsonConfiguration is null.

natural

public static JsonConfiguration.NaturalBuilder natural()

A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.NATURAL JSON notation. After getting the builder, you can set configuration options on it, and finally get an immutable JsonConfiguration instance using the JsonConfiguration.Builder.build() method.

Returns:

a builder for JsonConfiguration instance

mapped

public static JsonConfiguration.MappedBuilder mapped()

A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.MAPPED JSON notation. After getting the builder, you can set configuration options on it and finally get an immutable JsonConfiguration instance the using JsonConfiguration.Builder.build() method.

Returns:

a builder for JsonConfiguration instance

mappedJettison

public static JsonConfiguration.MappedJettisonBuilder mappedJettison()

A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.MAPPED_JETTISON JSON notation. After getting the builder, you can set configuration options on it and finally get an immutable JsonConfiguration instance using the JsonConfiguration.Builder.build() method.

Returns:

a builder for JsonConfiguration instance

badgerFish

public static JsonConfiguration.Builder badgerFish()

A static method for obtaining a builder of JsonConfiguration instance, which will use JsonConfiguration.Notation.BADGERFISH JSON notation. After getting the builder, you can set configuration options on it and finally get an immutable JsonConfiguration instance using the JsonConfiguration.Builder.build() method.

Returns:

a builder for JsonConfiguration instance

copyBuilder

public static JsonConfiguration.Builder copyBuilder(JsonConfiguration jc)

getNotation

public JsonConfiguration.Notation getNotation()

Returns JSON notation selected for this configuration

Returns:

JSON notation

getArrays

public Collection<String> getArrays()

Returns JSON array names property This property is valid for the JsonConfiguration.Notation.MAPPED notation only.

Returns:

collection of array names

See Also:

JsonConfiguration.MappedBuilder.arrays(java.lang.String...)

getAttributeAsElements

public Collection<String> getAttributeAsElements()

Returns names of attributes, which will be handled as elements This property is valid for the JsonConfiguration.Notation.MAPPED notation only.

Returns:

attribute as element names collection

See Also:

JsonConfiguration.MappedBuilder.attributeAsElement(java.lang.String...)

getXml2JsonNs

public Map<String,String> getXml2JsonNs()

Returns a map for XML to JSON namespace mapping This property is valid for the JsonConfiguration.Notation.MAPPED notation only.

Returns:

a map for XML to JSON namespace mapping

See Also:

JsonConfiguration.MappedBuilder.xml2JsonNs(java.util.Map)

getNsSeparator

public Character getNsSeparator()

Returns XML namespace separator, which is used when constructing JSON identifiers for XML elements/attributes in other than default namespace This property is valid for the JsonConfiguration.Notation.MAPPED notation only.

Returns:

XML namespace separator character

See Also:

JsonConfiguration.MappedBuilder.nsSeparator(java.lang.Character)

getNonStrings

public Collection<String> getNonStrings()

Returns names of JSON objects, which will be serialized out as non-strings, i.e. without delimiting their values with double quotes This property is valid for the JsonConfiguration.Notation.MAPPED notation only.

Returns:

name of non-string JSON objects

See Also:

JsonConfiguration.MappedBuilder.nonStrings(java.lang.String...)

isRootUnwrapping

public boolean isRootUnwrapping()

Says if the root element will be stripped off This property is valid for the JsonConfiguration.Notation.MAPPED and JsonConfiguration.Notation.NATURAL notations.

Returns:

true, if root element has to be stripped off

See Also:

JsonConfiguration.MappedBuilder.rootUnwrapping(boolean)

isUsingPrefixesAtNaturalAttributes

public boolean isUsingPrefixesAtNaturalAttributes()

Says if the JSON names corresponding to XML attributes should use a '@' prefix. This property is valid for the JsonConfiguration.Notation.NATURAL notation only.

Returns:

true, if prefixes are added

See Also:

JsonConfiguration.NaturalBuilder.usePrefixesAtNaturalAttributes()

isHumanReadableFormatting

public boolean isHumanReadableFormatting()

Says if the output JSON will be formatted with new-line characters and indentation so that it is easy to read for people. This property is valid for the JsonConfiguration.Notation.NATURAL notation only.

Returns:

true, if formatting is applied on the output JSON

See Also:

JsonConfiguration.NaturalBuilder.humanReadableFormatting(boolean)

toString

public String toString()

Overrides:

toString in class Object