org.apache.juneau.uon

Class UonSerializerSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.uon.UonSerializerSession

All Implemented Interfaces:

HttpPartSerializerSession

Direct Known Subclasses:

OpenApiSerializerSession, UrlEncodingSerializerSession

public class UonSerializerSession
extends WriterSerializerSession
implements HttpPartSerializerSession

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

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused within the same thread.

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

Constructor Summary

Constructors

Constructor and Description
UonSerializerSession(UonSerializer ctx, Boolean encode, SerializerSessionArgs args)

Method Summary

Modifier and Type	Method and Description
protected void	doSerialize(SerializerPipe out, Object o) Serializes a POJO to the specified output stream or writer.
protected ParamFormat	getParamFormat() Configuration property: Format to use for query/form-data/header values.
protected UonWriter	getUonWriter(SerializerPipe out) Converts the specified output target object to an UonWriter.
protected boolean	isAddBeanTypes() Configuration property: Add "_type" properties when needed.
protected boolean	isEncoding() Configuration property: Encode non-valid URI characters.
String	serialize(HttpPartSchema schema, Object value) Same as HttpPartSerializerSession.serialize(HttpPartType, HttpPartSchema, Object) but defaults to a null part type.
String	serialize(HttpPartType type, HttpPartSchema schema, Object value) Converts the specified value to a string that can be used as an HTTP header value, query parameter value, form-data parameter, or URI path variable.
protected SerializerWriter	serializeAnything(UonWriter out, Object o, ClassMeta<?> eType, String attrName, BeanPropertyMeta pMeta) Workhorse method.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

createPipe, getMaxIndent, getQuoteChar, isUseWhitespace, isWriterSerializer, serialize, serializeToString

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

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

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

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

UonSerializerSession

public UonSerializerSession(UonSerializer ctx,
                            Boolean encode,
                            SerializerSessionArgs args)

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

encode - Override the UonSerializer.UON_encoding setting.

args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

Method Detail

getUonWriter

protected final UonWriter getUonWriter(SerializerPipe out)
                                throws IOException

Converts the specified output target object to an UonWriter.

Parameters:

out - The output target object.

Returns:

The output target object wrapped in an UonWriter.

Throws:

IOException - Thrown by underlying stream.

doSerialize

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

Description copied from class: SerializerSession

Serializes a POJO to the specified output stream or writer.

This method should NOT close the context object.

Specified by:

doSerialize in class SerializerSession

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.

serializeAnything

protected SerializerWriter serializeAnything(UonWriter out,
                                             Object o,
                                             ClassMeta<?> eType,
                                             String attrName,
                                             BeanPropertyMeta pMeta)
                                      throws IOException,
                                             SerializeException

Workhorse method.

Determines the type of object, and then calls the appropriate type-specific serialization method.

Parameters:

out - The writer to serialize to.

o - The object being serialized.

eType - The expected type of the object if this is a bean property.

attrName - The bean property name if this is a bean property. null if this isn't a bean property being serialized.

pMeta - The bean property metadata.

Returns:

The same writer passed in.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Generic serialization error occurred.

serialize

public String serialize(HttpPartType type,
                        HttpPartSchema schema,
                        Object value)
                 throws SerializeException,
                        SchemaValidationException

Description copied from interface: HttpPartSerializerSession

Converts the specified value to a string that can be used as an HTTP header value, query parameter value, form-data parameter, or URI path variable.

Returned values should NOT be URL-encoded.

Specified by:

serialize in interface HttpPartSerializerSession

Parameters:

type - The category of value being serialized.

schema - Schema information about the part.
May be null.
Not all part serializers use the schema information.

value - The value being serialized.

Returns:

The serialized value.

Throws:

SerializeException - If a problem occurred while trying to parse the input.

SchemaValidationException - If the output fails schema validation.

serialize

public String serialize(HttpPartSchema schema,
                        Object value)
                 throws SerializeException,
                        SchemaValidationException

Description copied from interface: HttpPartSerializerSession

Same as HttpPartSerializerSession.serialize(HttpPartType, HttpPartSchema, Object) but defaults to a null part type.

Specified by:

serialize in interface HttpPartSerializerSession

Parameters:

schema - Schema information about the part.
May be null.
Not all part serializers use the schema information.

value - The value being serialized.

Returns:

The serialized value.

Throws:

SerializeException - If a problem occurred while trying to parse the input.

SchemaValidationException - If the output fails schema validation.

isAddBeanTypes

protected final boolean isAddBeanTypes()

Configuration property: Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class SerializerSession

Returns:

true if "_type" properties will be added to beans if their type cannot be inferred through reflection.

See Also:

UonSerializer.UON_addBeanTypes

isEncoding

protected final boolean isEncoding()

Configuration property: Encode non-valid URI characters.

Returns:

true if non-valid URI characters should be encoded with "%xx" constructs.

See Also:

UonSerializer.UON_encoding

getParamFormat

protected final ParamFormat getParamFormat()

Configuration property: Format to use for query/form-data/header values.

Returns:

Specifies the format to use for URL GET parameter keys and values.

See Also:

UonSerializer.UON_paramFormat

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 WriterSerializerSession

Returns:

A new map containing the properties defined on this context.