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

Direct Known Subclasses:

UrlEncodingParserSession

public class UonParserSession
extends ReaderParserSession

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 decodeChars) Create a specialized parser session for parsing URL parameters.

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.
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 ObjectMap	loc(UonReader r) Returns a map identifying the current parse location.
<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.

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

isReaderParser

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

cast, convertAttrToType, createPipe, getClassMeta, getJavaMethod, getLastLocation, getListener, getListener, getOuter, isStrict, isTrimStrings, onUnknownProperty, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap, setCurrentClass, setCurrentProperty, setName, setParent, trim, trim

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getLocale, getMediaType, getStringBuilder, getTimeZone, isBean, isBean, isDebug, isIgnoreUnknownBeanProperties, newBean, newBean, newBeanMap, newBeanMap, newInstance, newInstance, newInstanceFromOuter, 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, 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 decodeChars)

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.

decodeChars - Whether to decode characters.

Method Detail

asMap

public ObjectMap asMap()

Description copied from class: Session

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

Overrides:

asMap in class ParserSession

Returns:

A new map containing the properties defined on this context.

doParse

protected <T> T doParse(ParserPipe pipe,
                        ClassMeta<T> type)
                 throws Exception

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:

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

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.

parseAnything

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

Workhorse method.

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:

Exception

parseAttr

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

Convenience method for parsing an attribute from the specified parser.

Parameters:

r -

encoded -

Returns:

The parsed object

Throws:

Exception

parseAttrName

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

Parses an attribute name from the specified reader.

Parameters:

r -

encoded -

Returns:

The parsed attribute name.

Throws:

Exception

parseString

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

Parses a string value from the specified reader.

Parameters:

r -

isUrlParamValue -

Returns:

The parsed string.

Throws:

Exception

loc

protected final ObjectMap loc(UonReader r)

Returns a map identifying the current parse location.

Parameters:

r - The reader being read from.

Returns:

A map identifying the current parse location.

getUonReader

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

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:

Exception