Package org.apache.juneau.marshall.uon

Class UonParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.ReaderParser

org.apache.juneau.marshall.uon.UonParser

All Implemented Interfaces:

HttpPartParser, RecordReadable, UonMetaProvider

Direct Known Subclasses:

OpenApiParser, UonParser.Decoding, UrlEncodingParser

public class UonParser
extends ReaderParser
implements HttpPartParser, UonMetaProvider, RecordReadable

Parses UON (a notation for URL-encoded query parameter values) text into POJO models.

Media types

Handles Content-Type types: text/uon

Description

This parser uses a state machine, which makes it very fast and efficient.

Example input (Map of name/age):

(name=Alice,age=30)

Complex (nested object + array):

(name=Alice,age=30,address=(street=123+Main+St,city=Boston,state=MA),tags=@(a,b,c))

Notes:

• This class is thread safe and reusable.

See Also:

• UON

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UonParser.Builder<SELF extends UonParser.Builder<SELF>>	Builder class.
static class	UonParser.Decoding	Default parser, decoding.
static final class	UonParser.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() / copy() path.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Nested classes/interfaces inherited from interface org.apache.juneau.marshall.httppart.HttpPartParser

HttpPartParser.Creator, HttpPartParser.Void

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	decoding
static final UonParser	DEFAULT	Reusable instance of UonParser, all default settings.
static final UonParser	DEFAULT_DECODING	Reusable instance of UonParser with decodeChars set to true.
protected final boolean	validateEnd

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
UonParser(UonParser.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
UonParser.Builder<?>	copy()	Creates a builder from this context object.
static UonParser.Builder<?>	create()	Creates a new builder for this object.
UonParserSession.Builder<?>	createSession()	Create a session builder based on the properties defined on this context.
<T> ClassMeta<T>	getClassMeta(Class<T> c)	Returns metadata about the specified class.
<T> ClassMeta<T>	getClassMeta(Type t, Type... args)	Returns metadata about the specified class.
UonParserSession	getPartSession()	Creates a new parser session.
UonParserSession	getSession()	Returns a session to use for this context.
UonBeanPropertyMeta	getUonBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
UonClassMeta	getUonClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected final boolean	isDecoding()	Decode "%xx" sequences enabled
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
protected final boolean	isValidateEnd()	Validate end enabled.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
<T> T	read(HttpPartType partType, HttpPartSchema schema, String in, Class<T> toType)	Converts the specified input to the specified class type.
<T> T	read(HttpPartType partType, HttpPartSchema schema, String in, Type toType, Type... toTypeArgs)	Converts the specified input to the specified class type.
<T> T	read(HttpPartType partType, HttpPartSchema schema, String in, ClassMeta<T> toType)	Converts the specified input to the specified class type.
RecordReader	readRecords(Object input)	Convenience delegator that opens a whole-value RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParser

getStreamCharset, isReaderParser

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final UonParser DEFAULT

Reusable instance of UonParser, all default settings.

DEFAULT_DECODING

public static final UonParser DEFAULT_DECODING

Reusable instance of UonParser with decodeChars set to true.

decoding

protected final boolean decoding

validateEnd

protected final boolean validateEnd

Constructor Details

UonParser

public UonParser(UonParser.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static UonParser.Builder<?> create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public UonParser.Builder<?> copy()

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:

copy in class Parser

Returns:

A new Builder object.

createSession

public UonParserSession.Builder<?> createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class ReaderParser

Returns:

A new session builder.

getClassMeta

public <T> ClassMeta<T> getClassMeta(Class<T> c)

Description copied from interface: HttpPartParser

Returns metadata about the specified class.

Specified by:

getClassMeta in interface HttpPartParser

Type Parameters:

T - The class type.

Parameters:

c - The class type.

Returns:

Metadata about the specified class.

getClassMeta

public <T> ClassMeta<T> getClassMeta(Type t,
 Type... args)

Description copied from interface: HttpPartParser

Returns metadata about the specified class.

Specified by:

getClassMeta in interface HttpPartParser

Type Parameters:

T - The class type.

Parameters:

t - The class type.

args - The class type args.

Returns:

Metadata about the specified class.

getPartSession

public UonParserSession getPartSession()

Description copied from interface: HttpPartParser

Creates a new parser session.

Specified by:

getPartSession in interface HttpPartParser

Returns:

A new parser session.

getSession

public UonParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class ReaderParser

Returns:

A new session object.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Convenience delegator that opens a whole-value RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

The real implementation lives on UonParserSession.readRecords(Object). Callers that need request-derived configuration (locale, timezone, schema, swaps) should call createSession() and invoke UonParserSession.readRecords(Object) on the built session instead.

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred opening the underlying input.

isRecordStreaming

public boolean isRecordStreaming()

Description copied from interface: RecordReadable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

true if RecordReadable.readRecords(Object) returns an O(1)-memory streaming cursor; false for buffered (whole-value) formats backed by RecordAdapter.

getUonBeanPropertyMeta

public UonBeanPropertyMeta getUonBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: UonMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getUonBeanPropertyMeta in interface UonMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getUonClassMeta

public UonClassMeta getUonClassMeta(ClassMeta<?> cm)

Description copied from interface: UonMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getUonClassMeta in interface UonMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

read

public <T> T read(HttpPartType partType,
 HttpPartSchema schema,
 String in,
 Class<T> toType)
           throws ParseException,
SchemaValidationException

Converts the specified input to the specified class type.

Type Parameters:

T - The POJO type to transform the input into.

Parameters:

partType - The part type being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

read

public <T> T read(HttpPartType partType,
 HttpPartSchema schema,
 String in,
 ClassMeta<T> toType)
           throws ParseException,
SchemaValidationException

Converts the specified input to the specified class type.

Type Parameters:

T - The POJO type to transform the input into.

Parameters:

partType - The part type being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

read

public <T> T read(HttpPartType partType,
 HttpPartSchema schema,
 String in,
 Type toType,
 Type... toTypeArgs)
           throws ParseException,
SchemaValidationException

Converts the specified input to the specified class type.

Type Parameters:

T - The POJO type to transform the input into.

Parameters:

partType - The part type being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

toType - The POJO type to transform the input into.

toTypeArgs - The generic type arguments of the POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

isDecoding

protected final boolean isDecoding()

Decode "%xx" sequences enabled

Returns:

true if URI encoded characters should be decoded, false if they've already been decoded before being passed to this parser.

See Also:

• UonParser.Builder.decoding()

isValidateEnd

protected final boolean isValidateEnd()

Validate end enabled.

Returns:

true if after parsing a POJO from the input, verifies that the remaining input in the stream consists of only comments or whitespace.

See Also:

• UonParser.Builder.validateEnd()

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class ReaderParser

Returns:

The properties on this bean as a map for debugging.