Package org.apache.juneau.marshall.urlencoding

Class UrlEncodingParserSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.parser.ParserSession

org.apache.juneau.marshall.parser.ReaderParserSession

org.apache.juneau.marshall.uon.UonParserSession

org.apache.juneau.marshall.urlencoding.UrlEncodingParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, HttpPartParserSession, RecordReadable

public class UrlEncodingParserSession
extends UonParserSession

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

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• URL-Encoding

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UrlEncodingParserSession.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.uon.UonParserSession

UonParserSession.DefaultBuilder

Field Summary

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

DEFAULT_MAX_PARSE_DEPTH

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

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
UrlEncodingParserSession(UrlEncodingParserSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static UrlEncodingParserSession.Builder	create(UrlEncodingParser ctx)	Creates a new builder for this object.
protected <T> T	doRead(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
protected <K, V> Map<K,V>	doReadIntoMap(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 final boolean	isExpandedParams()	Parse bean property collections/arrays as separate key/value pairs.
final boolean	shouldUseExpandedParams(BeanPropertyMeta pMeta)	Returns true if the specified bean property should be expanded as multiple key-value pairs.

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

create, doReadIntoCollection, getUonReader, isDecoding, isRecordStreaming, isValidateEnd, properties, read, readAnything, readAttr, readAttrName, readRecords, readString

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

create, createPipe, getStreamCharset, isReaderParser

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

allocateLocal, cast, checkRequired, convertAttrToType, create, doReadToBeanConsumer, enterParseDepth, exitParseDepth, getCalendarFormat, getClassMeta, getDateFormat, getDebugOutputLines, getDurationFormat, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getLocaleFormat, getNulls, getOuter, getPeriodFormat, getPosition, getSchema, getStringBuilder, getTemporalFormat, getTimeZoneFormat, isAutoCloseStreams, isTrimStrings, isUnbuffered, mark, onBeanSetterException, onUnknownProperty, parentBean, read, read, read, read, read, read, readArgs, readCalendar, readDate, readDuration, readIntoCollection, readIntoMap, readPeriod, readTemporal, readToBeanConsumer, returnStringBuilder, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, swapParentBean, trim, trim, unmark, unswap

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

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

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

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Constructor Details

UrlEncodingParserSession

public UrlEncodingParserSession(UrlEncodingParserSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static UrlEncodingParserSession.Builder create(UrlEncodingParser ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

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.

doRead

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

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method or Parser.doRead(ParserSession,ParserPipe,ClassMeta).

The default implementation of this method simply calls Parser.doRead(ParserSession,ParserPipe,ClassMeta).

Overrides:

doRead 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, JsonMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

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

doReadIntoMap

protected <K,
V> Map<K,V> doReadIntoMap(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:

doReadIntoMap in class UonParserSession

Type Parameters:

K - The key type.

V - The value type.

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.

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.

isExpandedParams

protected final boolean isExpandedParams()

Parse 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.Builder.expandedParams()