Package org.apache.juneau.urlencoding

Class UrlEncodingParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.uon.UonParser

org.apache.juneau.urlencoding.UrlEncodingParser

All Implemented Interfaces:

AnnotationProvider, HttpPartParser, UonMetaProvider, UrlEncodingMetaProvider

public class UrlEncodingParser
extends UonParser
implements UrlEncodingMetaProvider

Parses URL-encoded text into POJO models.

Media types

Handles Content-Type types: application/x-www-form-urlencoded

Description

Parses URL-Encoded text (e.g. "foo=bar&baz=bing") into POJOs.

Expects parameter values to be in UON notation.

This parser uses a state machine, which makes it very fast and efficient.

Notes:

• This class is thread safe and reusable.

See Also:

• URL-Encoding Basics

Nested Class Summary

Nested Classes

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

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

UonParser.Decoding

Nested classes/interfaces inherited from class org.apache.juneau.parser.Parser

Parser.Null

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

HttpPartParser.Creator, HttpPartParser.Void

Field Summary

Fields

Modifier and Type	Field	Description
static final UrlEncodingParser	DEFAULT	Reusable instance of UrlEncodingParser.

Fields inherited from class org.apache.juneau.uon.UonParser

DEFAULT_DECODING

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Constructor	Description
UrlEncodingParser(UrlEncodingParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
UrlEncodingParser.Builder	copy()	Creates a builder from this context object.
static UrlEncodingParser.Builder	create()	Creates a new builder for this object.
UrlEncodingParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
UrlEncodingParserSession	getSession()	Returns a session to use for this context.
UrlEncodingBeanPropertyMeta	getUrlEncodingBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
UrlEncodingClassMeta	getUrlEncodingClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected final boolean	isExpandedParams()	Parser bean property collections/arrays as separate key/value pairs.
protected JsonMap	properties()	Returns the properties on this bean as a map for debugging.

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

getClassMeta, getClassMeta, getPartSession, getUonBeanPropertyMeta, getUonClassMeta, isDecoding, isValidateEnd, parse, parse, parse

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

getFileCharset, getStreamCharset, isReaderParser

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

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

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, 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.AnnotationProvider

firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation

Field Details

DEFAULT

public static final UrlEncodingParser DEFAULT

Reusable instance of UrlEncodingParser.

Constructor Details

UrlEncodingParser

public UrlEncodingParser(UrlEncodingParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static UrlEncodingParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public UrlEncodingParser.Builder copy()

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:

copy in class UonParser

Returns:

A new Builder object.

createSession

public UrlEncodingParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class UonParser

Returns:

A new session builder.

getSession

public UrlEncodingParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class UonParser

Returns:

A new session object.

getUrlEncodingClassMeta

public UrlEncodingClassMeta getUrlEncodingClassMeta(ClassMeta<?> cm)

Description copied from interface: UrlEncodingMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getUrlEncodingClassMeta in interface UrlEncodingMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getUrlEncodingBeanPropertyMeta

public UrlEncodingBeanPropertyMeta getUrlEncodingBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: UrlEncodingMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getUrlEncodingBeanPropertyMeta in interface UrlEncodingMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

isExpandedParams

protected final boolean isExpandedParams()

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

properties

protected JsonMap properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class UonParser

Returns:

The properties on this bean as a map for debugging.