org.apache.juneau.uon

Class UonParserSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.parser.ParserSession

org.apache.juneau.parser.ReaderParserSession

org.apache.juneau.uon.UonParserSession

All Implemented Interfaces:

HttpPartParserSession

Direct Known Subclasses:

OpenApiParserSession, UrlEncodingParserSession

public class UonParserSession
extends ReaderParserSession
implements HttpPartParserSession

Session object that lives for the duration of a single use of UonParser.

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused against multiple inputs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UonParserSession(UonParser ctx, ParserSessionArgs args) Create a new session using properties specified in the context.
protected	UonParserSession(UonParser ctx, ParserSessionArgs args, boolean decoding) Create a specialized parser session for parsing URL parameters.

Method Summary

Modifier and Type	Method and Description
protected <T> T	doParse(ParserPipe pipe, ClassMeta<T> type) Workhorse method.
protected <E> Collection<E>	doParseIntoCollection(ParserPipe pipe, Collection<E> c, Type elementType) Implementation method.
protected <K,V> Map<K,V>	doParseIntoMap(ParserPipe pipe, Map<K,V> m, Type keyType, Type valueType) Implementation method.
UonReader	getUonReader(ParserPipe pipe, boolean decodeChars) Creates a UonReader from the specified parser pipe.
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) Same as HttpPartParserSession.parse(HttpPartType, HttpPartSchema, String, Class) but defaults to a null part type.
<T> T	parse(HttpPartSchema schema, String in, ClassMeta<T> toType) Same as HttpPartParserSession.parse(HttpPartType, HttpPartSchema, String, ClassMeta) but defaults to a null part type.
<T> T	parse(HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Same as HttpPartParserSession.parse(HttpPartType, HttpPartSchema, String, Type, Type...) but defaults to a null part type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Class<T> toType) Converts the specified input to the specified class type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, ClassMeta<T> toType) Converts the specified input to the specified class type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Converts the specified input to the specified class type.
<T> T	parseAnything(ClassMeta<?> eType, UonReader r, Object outer, boolean isUrlParamValue, BeanPropertyMeta pMeta) Workhorse method.
protected Object	parseAttr(UonReader r, boolean encoded) Convenience method for parsing an attribute from the specified parser.
protected String	parseAttrName(UonReader r, boolean encoded) Parses an attribute name from the specified reader.
protected String	parseString(UonReader r, boolean isUrlParamValue) Parses a string value from the specified reader.
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.ReaderParserSession

createPipe, getFileCharset, getStreamCharset, isReaderParser

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

cast, convertAttrToType, getClassMeta, getDebugOutputLines, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getOuter, getPosition, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, mark, onUnknownProperty, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, trim, trim, unmark, unswap

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getBpi, getBpro, getBpwo, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getExamples, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UonParserSession

protected UonParserSession(UonParser ctx,
                           ParserSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime session arguments.

UonParserSession

protected UonParserSession(UonParser ctx,
                           ParserSessionArgs args,
                           boolean decoding)

Create a specialized parser session for parsing URL parameters.

The main difference is that characters are never decoded, and the UonParser.UON_decoding property is always ignored.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime session arguments.

decoding - Whether to decode characters.

Method Detail

doParse

protected <T> T doParse(ParserPipe pipe,
                        ClassMeta<T> type)
                 throws IOException,
                        ParseException,
                        ExecutableException

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method.

Specified by:

doParse in class ParserSession

Type Parameters:

T - The class type of the object to create.

Parameters:

pipe - Where to get the input from.

type - The class type of the object to create. If null or Object.class, object type is based on what's being parsed. For example, when parsing JSON text, it may return a String, Number, ObjectMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.

doParseIntoMap

protected <K,V> Map<K,V> doParseIntoMap(ParserPipe pipe,
                                        Map<K,V> m,
                                        Type keyType,
                                        Type valueType)
                                 throws Exception

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doParseIntoMap in class ParserSession

Parameters:

pipe - The parser input.

m - The map being loaded.

keyType - The class type of the keys, or null to default to String.class.

valueType - The class type of the values, or null to default to whatever is being parsed.

Returns:

The same map that was passed in to allow this method to be chained.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

doParseIntoCollection

protected <E> Collection<E> doParseIntoCollection(ParserPipe pipe,
                                                  Collection<E> c,
                                                  Type elementType)
                                           throws Exception

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doParseIntoCollection in class ParserSession

Parameters:

pipe - The parser input.

c - The collection being loaded.

elementType - The class type of the elements, or null to default to whatever is being parsed.

Returns:

The same collection that was passed in to allow this method to be chained.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

parse

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

Description copied from interface: HttpPartParserSession

Converts the specified input to the specified class type.

Specified by:

parse in interface HttpPartParserSession

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.

parse

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

Description copied from interface: HttpPartParserSession

Converts the specified input to the specified class type.

Specified by:

parse in interface HttpPartParserSession

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.

parse

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

Description copied from interface: HttpPartParserSession

Converts the specified input to the specified class type.

Specified by:

parse in interface HttpPartParserSession

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 POJO type arguments for Collection and Map types.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

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

parse

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

Description copied from interface: HttpPartParserSession

Same as HttpPartParserSession.parse(HttpPartType, HttpPartSchema, String, Class) but defaults to a null part type.

Specified by:

parse in interface HttpPartParserSession

Parameters:

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.

parse

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

Description copied from interface: HttpPartParserSession

Same as HttpPartParserSession.parse(HttpPartType, HttpPartSchema, String, ClassMeta) but defaults to a null part type.

Specified by:

parse in interface HttpPartParserSession

Parameters:

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.

parse

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

Description copied from interface: HttpPartParserSession

Same as HttpPartParserSession.parse(HttpPartType, HttpPartSchema, String, Type, Type...) but defaults to a null part type.

Specified by:

parse in interface HttpPartParserSession

Parameters:

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 POJO type arguments for Collection and Map types.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

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

parseAnything

public <T> T parseAnything(ClassMeta<?> eType,
                           UonReader r,
                           Object outer,
                           boolean isUrlParamValue,
                           BeanPropertyMeta pMeta)
                    throws IOException,
                           ParseException,
                           ExecutableException

Workhorse method.

Type Parameters:

T - The class type being parsed, or null if unknown.

Parameters:

eType - The class type being parsed, or null if unknown.

r - The reader being parsed.

outer - The outer object (for constructing nested inner classes).

isUrlParamValue - If true, then we're parsing a top-level URL-encoded value which is treated a bit different than the default case.

pMeta - The current bean property being parsed.

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.

parseAttr

protected final Object parseAttr(UonReader r,
                                 boolean encoded)
                          throws IOException,
                                 ParseException

Convenience method for parsing an attribute from the specified parser.

Parameters:

r - The reader.

encoded - Whether the attribute is encoded.

Returns:

The parsed object

Throws:

IOException - Exception thrown by underlying stream.

ParseException - Attribute was malformed.

parseAttrName

protected final String parseAttrName(UonReader r,
                                     boolean encoded)
                              throws IOException,
                                     ParseException

Parses an attribute name from the specified reader.

Parameters:

r - The reader.

encoded - Whether the attribute is encoded.

Returns:

The parsed attribute name.

Throws:

IOException - Exception thrown by underlying stream.

ParseException - Attribute name was malformed.

parseString

protected final String parseString(UonReader r,
                                   boolean isUrlParamValue)
                            throws IOException,
                                   ParseException

Parses a string value from the specified reader.

Parameters:

r - The input reader.

isUrlParamValue - Whether this is a URL parameter.

Returns:

The parsed string.

Throws:

IOException - Exception thrown by underlying stream.

ParseException - Malformed input found.

getUonReader

public final UonReader getUonReader(ParserPipe pipe,
                                    boolean decodeChars)
                             throws IOException

Creates a UonReader from the specified parser pipe.

Parameters:

pipe - The parser input.

decodeChars - Whether the reader should automatically decode URL-encoded characters.

Returns:

A new UonReader object.

Throws:

IOException - Thrown by underlying stream.

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:

UonParser.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:

UonParser.UON_validateEnd

toMap

public ObjectMap toMap()

Description copied from class: Session

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

Overrides:

toMap in class ReaderParserSession

Returns:

A new map containing the properties defined on this context.