org.apache.juneau.urlencoding

Class UrlEncodingParserSession

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

org.apache.juneau.urlencoding.UrlEncodingParserSession

All Implemented Interfaces:

HttpPartParserSession

public class UrlEncodingParserSession
extends UonParserSession

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

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	UrlEncodingParserSession(UrlEncodingParser ctx, ParserSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
protected <T> T	doParse(ParserPipe pipe, ClassMeta<T> type) Workhorse method.
protected <K,V> Map<K,V>	doParseIntoMap(ParserPipe pipe, Map<K,V> m, Type keyType, Type valueType) Implementation method.
protected UrlEncodingClassMeta	getUrlEncodingClassMeta(ClassMeta<?> cm) Returns the language-specific metadata on the specified class.
protected boolean	isExpandedParams() Configuration property: Parser bean property collections/arrays as separate key/value pairs.
boolean	shouldUseExpandedParams(BeanPropertyMeta pMeta) Returns true if the specified bean property should be expanded as multiple key-value pairs.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

Methods inherited from class org.apache.juneau.uon.UonParserSession

doParseIntoCollection, getUonReader, isDecoding, isValidateEnd, parse, parse, parse, parse, parse, parse, parseAnything, parseAttr, parseAttrName, parseString

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

UrlEncodingParserSession

protected UrlEncodingParserSession(UrlEncodingParser 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.

Method Detail

shouldUseExpandedParams

public final boolean shouldUseExpandedParams(BeanPropertyMeta pMeta)

Returns true if the specified bean property should be expanded as multiple key-value pairs.

Parameters:

pMeta - The metadata on the bean property.

Returns:

true if the specified bean property should be expanded as multiple key-value pairs.

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.

Overrides:

doParse in class UonParserSession

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 UonParserSession

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.

isExpandedParams

protected final boolean isExpandedParams()

Configuration property: Parser bean property collections/arrays as separate key/value pairs.

Returns:

false if serializing the array [1,2,3] results in ?key=$a(1,2,3).
true if serializing the same array results in ?key=1&key=2&key=3.

See Also:

UrlEncodingParser.URLENC_expandedParams

getUrlEncodingClassMeta

protected UrlEncodingClassMeta getUrlEncodingClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

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 UonParserSession

Returns:

A new map containing the properties defined on this context.