Package org.apache.juneau.urlencoding

Class UrlEncodingSerializerSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.uon.UonSerializerSession

org.apache.juneau.urlencoding.UrlEncodingSerializerSession

All Implemented Interfaces:

HttpPartSerializerSession

public class UrlEncodingSerializerSession
extends UonSerializerSession

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

Notes:

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

See Also:

• URL-Encoding Basics

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UrlEncodingSerializerSession(UrlEncodingSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static UrlEncodingSerializerSession.Builder	create(UrlEncodingSerializer ctx)	Creates a new builder for this object.
protected void	doSerialize(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected UrlEncodingClassMeta	getUrlEncodingClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected final boolean	isExpandedParams()	Serialize bean property collections/arrays as separate key/value pairs.

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

create, getParamFormat, getQuoteChar, getUonWriter, isAddBeanTypes, isEncoding, serialize, serializeAnything

Methods inherited from class org.apache.juneau.serializer.WriterSerializerSession

create, createPipe, getFileCharset, getMaxIndent, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, serialize, serializeToString

Methods inherited from class org.apache.juneau.serializer.SerializerSession

addVarBean, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getSchema, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, serialize, sort, sort, sort, swap, toList, toString, trim

Methods inherited from class org.apache.juneau.BeanTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, pop, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

Methods inherited from class org.apache.juneau.BeanSession

_class, addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Details

UrlEncodingSerializerSession

protected UrlEncodingSerializerSession(UrlEncodingSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static UrlEncodingSerializerSession.Builder create(UrlEncodingSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

doSerialize

protected void doSerialize(SerializerPipe out,
 Object o)
                    throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doSerialize(SerializerSession,SerializerPipe,Object).

Overrides:

doSerialize in class UonSerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

isExpandedParams

protected final boolean isExpandedParams()

Serialize 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:

• UrlEncodingSerializer.Builder.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.