org.apache.juneau.uon

Class UonParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.uon.UonParser

All Implemented Interfaces:

HttpPartParser

Direct Known Subclasses:

OpenApiParser, UonParser.Decoding, UrlEncodingParser

@ConfigurableContext
public class UonParser
extends ReaderParser
implements HttpPartParser

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UonParser.Decoding Default parser, decoding.

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

HttpPartParser.Null

Field Summary

Fields

Modifier and Type	Field and Description
static UonParser	DEFAULT Reusable instance of UonParser, all default settings.
static UonParser	DEFAULT_DECODING Reusable instance of UonParser with decodeChars set to true.
static String	UON_decoding Configuration property: Decode "%xx" sequences.
static String	UON_validateEnd Configuration property: Validate end.

Fields inherited from class org.apache.juneau.parser.ReaderParser

RPARSER_fileCharset, RPARSER_streamCharset

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

PARSER_autoCloseStreams, PARSER_debugOutputLines, PARSER_listener, PARSER_strict, PARSER_trimStrings, PARSER_unbuffered

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_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, 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_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
UonParser(PropertyStore ps) Constructor.
UonParser(PropertyStore ps, String... consumes) Constructor.

Method Summary

Modifier and Type	Method and Description
UonParserBuilder	builder() Creates a builder from this context object.
static UonParserBuilder	create() Instantiates a new clean-slate UonParserBuilder object.
protected UonParserSession	createParameterSession() Create a UON parser session for parsing parameter values.
UonParserSession	createPartSession() Creates a new no-argument parser session.
UonParserSession	createPartSession(ParserSessionArgs args) Creates a new parser session.
UonParserSession	createSession() Create a new bean session based on the properties defined on this context.
UonParserSession	createSession(ParserSessionArgs args) Create the session object that will be passed in to the parse method.
protected boolean	isDecoding() Configuration property: Decode "%xx" sequences.
protected boolean	isValidateEnd() Configuration property: Validate end.
<T> T	parse(HttpPartSchema schema, String in, Class<T> toType) Convenience method for creating a no-arg session and parsing a part of an unspecified part type.
<T> T	parse(HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Convenience method for creating a no-arg session and parsing a part of an unspecified part type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Class<T> toType) Convenience method for creating a no-arg session and parsing a part.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Convenience method for creating a no-arg session and parsing a part.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

getFileCharset, getStreamCharset, isReaderParser

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

canHandle, createDefaultSessionArgs, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getImplClassConstructor, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, 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, getStringPropertyWithNone, hashCode, identityCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

UON_decoding

public static final String UON_decoding

Configuration property: Decode "%xx" sequences.

Property:

• Name: "UonParser.decoding.b"
• Data type: Boolean
• Default: false for UonParser, true for UrlEncodingParser
• Session property: false
• Methods:
  • UonParserBuilder.decoding(boolean)
  • UonParserBuilder.decoding()

Description:

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

Example:

// Create a decoding UON parser. ReaderParser p = UonParser. .create() .decoding() .build(); // Same, but use property. ReaderParser p = UonParser. .create() .set(UON_decoding, true) .build(); // Produces: ["foo bar", "baz quz"]. String[] foo = p.parse("@(foo%20bar,baz%20qux)", String[].class);

See Also:

Constant Field Values

UON_validateEnd

public static final String UON_validateEnd

Configuration property: Validate end.

Property:

• Name: "UonParser.validateEnd.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • UonParserBuilder.validateEnd(boolean)
  • UonParserBuilder.validateEnd()

Description:

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

Example:

// Create a parser using strict mode. ReaderParser p = UonParser. .create() .validateEnd() .build(); // Same, but use property. ReaderParser p = UonParser. .create() .set(UON_validateEnd, true) .build(); // Should fail because input has multiple POJOs. String in = "(foo=bar)(baz=qux)"; MyBean myBean = p.parse(in, MyBean.class);

See Also:

Constant Field Values

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.

Constructor Detail

UonParser

public UonParser(PropertyStore ps)

Constructor.

Parameters:

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

UonParser

public UonParser(PropertyStore ps,
                 String... consumes)

Constructor.

Parameters:

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

consumes - The list of media types that this parser consumes (e.g. "application/json", "*/json").

Method Detail

builder

public UonParserBuilder 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 Parser

Returns:

A new ContextBuilder object.

create

public static UonParserBuilder create()

Instantiates a new clean-slate UonParserBuilder object.

This is equivalent to simply calling new UonParserBuilder().

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 UonParserBuilder object.

createParameterSession

protected final UonParserSession createParameterSession()

Create a UON parser session for parsing parameter values.

Returns:

A new parser session.

createSession

public UonParserSession createSession(ParserSessionArgs args)

Description copied from class: Parser

Create the session object that will be passed in to the parse method.

It's up to implementers to decide what the session object looks like, although typically it's going to be a subclass of ParserSession.

Specified by:

createSession in class Parser

Parameters:

args - Runtime arguments.

Returns:

The new session.

createSession

public UonParserSession createSession()

Description copied from class: BeanContext

Create a new bean session based on the properties defined on this context.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class Parser

Returns:

A new session object.

createPartSession

public UonParserSession createPartSession(ParserSessionArgs args)

Description copied from interface: HttpPartParser

Creates a new parser session.

Specified by:

createPartSession in interface HttpPartParser

Parameters:

args - The runtime arguments for the session.

Returns:

A new parser session.

createPartSession

public UonParserSession createPartSession()

Description copied from interface: HttpPartParser

Creates a new no-argument parser session.

Specified by:

createPartSession in interface HttpPartParser

Returns:

A new parser session.

parse

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

Description copied from interface: HttpPartParser

Convenience method for creating a no-arg session and parsing a part.

Specified by:

parse in interface HttpPartParser

Parameters:

partType - The category of value being parsed.

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

in - The value being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.

parse

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

Description copied from interface: HttpPartParser

Convenience method for creating a no-arg session and parsing a part.

Specified by:

parse in interface HttpPartParser

Parameters:

partType - The category of value being parsed.

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

in - The value being parsed.

toType - The POJO type to transform the input into.

toTypeArgs - The POJO type arguments for Collections and Maps.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.

parse

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

Description copied from interface: HttpPartParser

Convenience method for creating a no-arg session and parsing a part of an unspecified part type.

Specified by:

parse in interface HttpPartParser

Parameters:

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

in - The value being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.

parse

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

Description copied from interface: HttpPartParser

Convenience method for creating a no-arg session and parsing a part of an unspecified part type.

Specified by:

parse in interface HttpPartParser

Parameters:

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

in - The value being parsed.

toType - The POJO type to transform the input into.

toTypeArgs - The POJO type arguments for Collections and Maps.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.

isDecoding

protected final boolean isDecoding()

Configuration property: Decode "%xx" sequences.

Returns:

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

See Also:

UON_decoding

isValidateEnd

protected final boolean isValidateEnd()

Configuration property: Validate end.

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:

UON_validateEnd

toMap

public ObjectMap toMap()

Description copied from class: Context

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

Overrides:

toMap in class ReaderParser

Returns:

A new map containing the properties defined on this context.