org.apache.juneau.uon

Class UonSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.uon.UonSerializer

Direct Known Subclasses:

UonPartSerializer, UonSerializer.Encoding, UonSerializer.Readable, UrlEncodingSerializer

public class UonSerializer
extends WriterSerializer

Serializes POJO models to UON (a notation for URL-encoded query parameter values).

Media types

Handles Accept types: text/uon

Produces Content-Type types: text/uon

Description

This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. However, custom serializers can be constructed to fine-tune behavior.

The following shows a sample object defined in Javascript:

{ id: 1, name: 'John Smith', uri: 'http://sample/addressBook/person/1', addressBookUri: 'http://sample/addressBook', birthDate: '1946-08-12T00:00:00Z', otherIds: null, addresses: [ { uri: 'http://sample/addressBook/address/1', personUri: 'http://sample/addressBook/person/1', id: 1, street: '100 Main Street', city: 'Anywhereville', state: 'NY', zip: 12345, isCurrent: true, } ] }

Using the "strict" syntax defined in this document, the equivalent UON notation would be as follows:

( id=1, name='John+Smith', uri=http://sample/addressBook/person/1, addressBookUri=http://sample/addressBook, birthDate=1946-08-12T00:00:00Z, otherIds=null, addresses=@( ( uri=http://sample/addressBook/address/1, personUri=http://sample/addressBook/person/1, id=1, street='100+Main+Street', city=Anywhereville, state=NY, zip=12345, isCurrent=true ) ) )

Example:

// Serialize a Map Map m = new ObjectMap("{a:'b',c:1,d:false,e:['f',1,false],g:{h:'i'}}"); // Serialize to value equivalent to JSON. // Produces "(a=b,c=1,d=false,e=@(f,1,false),g=(h=i))" String s = UonSerializer.DEFAULT.serialize(s); // Serialize a bean public class Person { public Person(String s); public String getName(); public int getAge(); public Address getAddress(); public boolean deceased; } public class Address { public String getStreet(); public String getCity(); public String getState(); public int getZip(); } Person p = new Person("John Doe", 23, "123 Main St", "Anywhere", "NY", 12345, false); // Produces "(name='John Doe',age=23,address=(street='123 Main St',city=Anywhere,state=NY,zip=12345),deceased=false)" String s = UonSerializer.DEFAULT.serialize(s);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UonSerializer.Encoding Equivalent to UonSerializer.create().encoding().build();.
static class	UonSerializer.Readable Equivalent to UonSerializer.create().ws().build();.

Field Summary

Fields

Modifier and Type	Field and Description
static UonSerializer	DEFAULT Reusable instance of UonSerializer, all default settings.
static UonSerializer	DEFAULT_ENCODING Reusable instance of UonSerializer.Encoding.
static UonSerializer	DEFAULT_READABLE Reusable instance of UonSerializer.Readable.
static String	UON_addBeanTypeProperties Configuration property: Add "_type" properties when needed.
static String	UON_encoding Configuration property: Encode non-valid URI characters.
static String	UON_paramFormat Configuration property: Format to use for query/form-data/header values.

Fields inherited from class org.apache.juneau.serializer.Serializer

SERIALIZER_abridged, SERIALIZER_addBeanTypeProperties, SERIALIZER_detectRecursions, SERIALIZER_ignoreRecursions, SERIALIZER_initialDepth, SERIALIZER_listener, SERIALIZER_maxDepth, SERIALIZER_maxIndent, SERIALIZER_quoteChar, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution, SERIALIZER_useWhitespace

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_debug, BEAN_excludeProperties, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
UonSerializer(PropertyStore ps) Constructor.
UonSerializer(PropertyStore ps, String produces, String... accept) Constructor.

Method Summary

Modifier and Type	Method and Description
ObjectMap	asMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
UonSerializerBuilder	builder() Creates a builder from this context object.
static UonSerializerBuilder	create() Instantiates a new clean-slate UonSerializerBuilder object.
WriterSerializerSession	createSession(SerializerSessionArgs args) Create the session object used for actual serialization of objects.

Methods inherited from class org.apache.juneau.serializer.WriterSerializer

isWriterSerializer, println, serialize, toString, toStringObject

Methods inherited from class org.apache.juneau.serializer.Serializer

createDefaultSessionArgs, createSession, getMediaTypes, getResponseContentType, serialize

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, hasSameCache, isBean, isNotABean, newInstance, newInstance, newInstanceFromOuter, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UON_addBeanTypeProperties

public static final String UON_addBeanTypeProperties

Configuration property: Add "_type" properties when needed.

Property:

• Name: "UonSerializer.addBeanTypeProperties.b"
• Data type: Boolean
• Default: true
• Session-overridable: true
• Methods:
  • UonSerializerBuilder.addBeanTypeProperties(boolean)

Description:

If true, then "_type" properties will be added to beans if their type cannot be inferred through reflection.

When present, this value overrides the Serializer.SERIALIZER_addBeanTypeProperties setting and is provided to customize the behavior of specific serializers in a SerializerGroup.

See Also:

Constant Field Values

UON_encoding

public static final String UON_encoding

Configuration property: Encode non-valid URI characters.

Property:

• Name: "UonSerializer.encoding.b"
• Data type: Boolean
• Default: false for UonSerializer, true for UrlEncodingSerializer
• Session-overridable: true
• Methods:
  • UonSerializerBuilder.encoding(boolean)
  • UonSerializerBuilder.encoding()

Description:

Encode non-valid URI characters with "%xx" constructs.

If true, non-valid URI characters will be converted to "%xx" sequences.
Set to false if parameter value is being passed to some other code that will already perform URL-encoding of non-valid URI characters.

Example:

// Create a non-encoding UON serializer. UonSerializer s1 = UonSerializer. .create() .build(); // Create an encoding UON serializer. UonSerializer s2 = UonSerializer. .create() .encoding() .build(); ObjectMap m = new ObjectMap().append("foo", "foo bar"); // Produces: "(foo=foo bar)" String uon1 = s1.serialize(m) // Produces: "(foo=foo%20bar)" String uon2 = s2.serialize(m)

See Also:

Constant Field Values

UON_paramFormat

public static final String UON_paramFormat

Configuration property: Format to use for query/form-data/header values.

Property:

• Name: "UrlEncodingSerializer.paramFormat.s"
• Data type: String (ParamFormat)
• Default: "UON"
• Session-overridable: true
• Methods:
  • UonSerializerBuilder.paramFormat(ParamFormat)
  • UonSerializerBuilder.paramFormatPlain()

Description:

Specifies the format to use for URL GET parameter keys and values.

Possible values:

• ParamFormat.UON - Use UON notation for parameters.
• ParamFormat.PLAINTEXT - Use plain text for parameters.

Example:

// Create a normal UON serializer. UonSerializer s1 = UonSerializer. .create() .build(); // Create a plain-text UON serializer. UonSerializer s2 = UonSerializer. .create() .paramFormat(PLAIN_TEXT) .build(); ObjectMap m = new ObjectMap() .append("foo", "bar"); .append("baz", new String[]{"qux", "true", "123"}); // Produces: "(foo=bar,baz=@(qux,'true','123'))" String uon1 = s1.serialize(m) // Produces: "foo=bar,baz=qux,true,123" String uon2 = s2.serialize(m)

See Also:

Constant Field Values

DEFAULT

public static final UonSerializer DEFAULT

Reusable instance of UonSerializer, all default settings.

DEFAULT_READABLE

public static final UonSerializer DEFAULT_READABLE

Reusable instance of UonSerializer.Readable.

DEFAULT_ENCODING

public static final UonSerializer DEFAULT_ENCODING

Reusable instance of UonSerializer.Encoding.

Constructor Detail

UonSerializer

public UonSerializer(PropertyStore ps)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

UonSerializer

public UonSerializer(PropertyStore ps,
                     String produces,
                     String... accept)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

produces - The media type that this serializer produces.

accept - The accept media types that the serializer can handle.

Can contain meta-characters per the media-type specification of RFC2616/14.1

If empty, then assumes the only media type supported is produces.

For example, if this serializer produces "application/json" but should handle media types of "application/json" and "text/json", then the arguments should be:

super(ps, "application/json", "application/json", "text/json");

...or...

super(ps, "application/json", "*/json");

Method Detail

builder

public UonSerializerBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class Serializer

Returns:

A new ContextBuilder object.

create

public static UonSerializerBuilder create()

Instantiates a new clean-slate UonSerializerBuilder object.

This is equivalent to simply calling new UonSerializerBuilder().

Note that this method creates a builder initialized to all default settings, whereas builder() copies the settings of the object called on.

Returns:

A new UonSerializerBuilder object.

createSession

public WriterSerializerSession createSession(SerializerSessionArgs args)

Description copied from class: Serializer

Create the session object used for actual serialization of objects.

Specified by:

createSession in class WriterSerializer

Parameters:

args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

Returns:

The new session object.

asMap

public ObjectMap asMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

asMap in class Serializer

Returns:

A new map containing the properties defined on this context.