SerializerSession (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.Session
- - org.apache.juneau.BeanSession
  - - org.apache.juneau.serializer.SerializerSession

Direct Known Subclasses:

OutputStreamSerializerSession, WriterSerializerSession
```
public abstract class SerializerSession
extends BeanSession
```
Serializer session that lives for the duration of a single use of Serializer.
Used by serializers for the following purposes:
- Keeping track of how deep it is in a model for indentation purposes.
- Ensuring infinite loops don't occur by setting a limit on how deep to traverse a model.
- Ensuring infinite loops don't occur from loops in the model (when detectRecursions is enabled.
- Allowing serializer properties to be overridden on method calls.
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
Modifier and Type Field and Description

int indent
The current indentation depth into the model.

Fields
Modifier and Type	Field and Description
`int`	`indent` The current indentation depth into the model.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SerializerSession(Serializer ctx, SerializerSessionArgs args)` Create a new session using properties specified in the context.
`protected`	`SerializerSession(SerializerSessionArgs args)` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectMap`	`asMap()` Returns the properties defined on this bean context as a simple map for debugging purposes.
`protected boolean`	`canIgnoreValue(ClassMeta<?> cm, String attrName, Object value)` Returns true if the specified value should not be serialized.
`protected static BeanPropertyValue`	`createBeanTypeNameProperty(BeanMap<?> m, String typeName)` Create a "_type" property that contains the dictionary name of the bean.
`protected SerializerPipe`	`createPipe(Object output)` Wraps the specified input object into a `ParserPipe` object so that it can be easily converted into a stream or reader.
`protected abstract void`	`doSerialize(SerializerPipe pipe, Object o)` Serializes a POJO to the specified output stream or writer.
`protected Object`	`generalize(Object o, ClassMeta<?> type)` Generalize the specified object if a POJO swap is associated with it.
`protected String`	`getBeanTypeName(ClassMeta<?> eType, ClassMeta<?> aType, BeanPropertyMeta pMeta)` Resolves the dictionary name for the actual type.
`protected ClassMeta<?>`	`getExpectedRootType(Object o)` Returns the parser-side expected type for the object.
`protected int`	`getInitialDepth()` Returns the `Serializer.SERIALIZER_initialDepth` setting value for this session.
`protected Method`	`getJavaMethod()` Returns the Java method that invoked this serializer.
`protected ObjectMap`	`getLastLocation()` Returns information used to determine at what location in the parse a failure occurred.
`SerializerListener`	`getListener()` Returns the listener associated with this session.
`<T extends SerializerListener> T`	`getListener(Class<T> c)` Returns the listener associated with this session.
`protected int`	`getMaxDepth()` Returns the `Serializer.SERIALIZER_maxDepth` setting value for this session.
`protected int`	`getMaxIndent()` Returns the `Serializer.SERIALIZER_maxIndent` setting value for this session.
`protected char`	`getQuoteChar()` Returns the `Serializer.SERIALIZER_quoteChar` setting value for this session.
`Map<String,String>`	`getResponseHeaders()` Optional method that specifies HTTP request headers for this serializer.
`protected UriResolver`	`getUriResolver()` Returns the URI resolver.
`protected boolean`	`isAddBeanTypeProperties()` Returns the `Serializer.SERIALIZER_addBeanTypeProperties` setting value for this session.
`protected boolean`	`isDetectRecursions()` Returns the `Serializer.SERIALIZER_detectRecursions` setting value for this session.
`protected boolean`	`isIgnoreRecursions()` Returns the `Serializer.SERIALIZER_ignoreRecursions` setting value for this session.
`protected boolean`	`isSortCollections()` Returns the `Serializer.SERIALIZER_sortCollections` setting value for this session.
`protected boolean`	`isSortMaps()` Returns the `Serializer.SERIALIZER_sortMaps` setting value for this session.
`protected boolean`	`isTrimEmptyCollections()` Returns the `Serializer.SERIALIZER_trimEmptyCollections` setting value for this session.
`protected boolean`	`isTrimEmptyMaps()` Returns the `Serializer.SERIALIZER_trimEmptyMaps` setting value for this session.
`protected boolean`	`isTrimNulls()` Returns the `Serializer.SERIALIZER_trimNullProperties` setting value for this session.
`protected boolean`	`isTrimStrings()` Returns the `Serializer.SERIALIZER_trimStrings` setting value for this session.
`protected boolean`	`isUseWhitespace()` Returns the `Serializer.SERIALIZER_useWhitespace` setting value for this session.
`abstract boolean`	`isWriterSerializer()` Returns true if this serializer subclasses from `WriterSerializer`.
`protected void`	`onBeanGetterException(BeanPropertyMeta p, Throwable t)` Specialized warning when an exception is thrown while executing a bean getter.
`protected void`	`onError(Throwable t, String msg, Object... args)` Logs a warning message.
`protected void`	`pop()` Pop an object off the stack.
`protected ClassMeta<?>`	`push(String attrName, Object o, ClassMeta<?> eType)` Push the specified object onto the stack.
`protected String`	`relativizeUri(Object relativeTo, Object uri)` Opposite of `resolveUri(Object)`.
`String`	`resolveUri(Object uri)` Converts a String to an absolute URI based on the `UriContext` on this session.
`abstract Object`	`serialize(Object o)` Shortcut method for serializing objects directly to either a `String` or `byte[]` depending on the serializer type.
`void`	`serialize(Object o, Object out)` Serialize the specified object using the specified session.
`protected void`	`setCurrentClass(ClassMeta<?> currentClass)` Sets the current class being serialized for proper error messages.
`protected void`	`setCurrentProperty(BeanPropertyMeta currentProperty)` Sets the current bean property being serialized for proper error messages.
`protected <E> Collection<E>`	`sort(Collection<E> c)` Sorts the specified collection if `isSortCollections()` returns true.
`protected <K,V> Map<K,V>`	`sort(Map<K,V> m)` Sorts the specified map if `isSortMaps()` returns true.
`protected static List<Object>`	`toList(Class<?> type, Object array)` Converts the contents of the specified object array to a list.
`String`	`toString(Object o)` Converts the specified object to a `String`.
`protected String`	`trim(Object o)` Trims the specified string if `isTrimStrings()` returns true.
`protected boolean`	`willRecurse(String attrName, Object o, ClassMeta<?> cm)` Returns true if `Serializer.SERIALIZER_detectRecursions` is enabled, and the specified object is already higher up in the serialization chain.

Methods inherited from class org.apache.juneau.BeanSession
_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getLocale, getMediaType, getStringBuilder, getTimeZone, isBean, isBean, isDebug, isIgnoreUnknownBeanProperties, newBean, newBean, newBeanMap, newBeanMap, newInstance, newInstance, newInstanceFromOuter, 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, hasWarnings, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - indent
```
public int indent
```
    The current indentation depth into the model.
- Constructor Detail
  - SerializerSession
```
protected SerializerSession(Serializer ctx,
                            SerializerSessionArgs 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. Can be null.
    
    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.
  - SerializerSession
```
protected SerializerSession(SerializerSessionArgs args)
```
    Default constructor.
    
    Parameters:
    
    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
  - asMap
```
public ObjectMap asMap()
```
    Description copied from class: Session
    
    Returns the properties defined on this bean context as a simple map for debugging purposes.
    
    Overrides:
    
    asMap in class BeanSession
    
    Returns:
    
    A new map containing the properties defined on this context.
  - createPipe
```
protected SerializerPipe createPipe(Object output)
```
    Wraps the specified input object into a ParserPipe object so that it can be easily converted into a stream or reader.
    Parameters:
    output - The output location.
    For character-based serializers, this can be any of the following types:
    
    Writer
    OutputStream - Output will be written as UTF-8 encoded stream.
    File - Output will be written as system-default encoded stream.
    StringBuilder
    
    For byte-based serializers, this can be any of the following types:
    
    OutputStream
    File
    Returns:
    
    A new ParserPipe wrapper around the specified input object.
  - doSerialize
```
protected abstract void doSerialize(SerializerPipe pipe,
                                    Object o)
                             throws Exception
```
    Serializes a POJO to the specified output stream or writer.
    This method should NOT close the context object.
    
    Parameters:
    
    pipe - Where to send the output from the serializer.
    
    o - The object to serialize.
    
    Throws:
    
    Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.
  - serialize
```
public abstract Object serialize(Object o)
                          throws SerializeException
```
    Shortcut method for serializing objects directly to either a String or byte[] depending on the serializer type.
    
    Parameters:
    
    o - The object to serialize.
    
    Returns:
    
    The serialized object.
    Character-based serializers will return a String
    Stream-based serializers will return a byte[]
    
    Throws:
    
    SerializeException - If a problem occurred trying to convert the output.
  - isWriterSerializer
```
public abstract boolean isWriterSerializer()
```
    Returns true if this serializer subclasses from WriterSerializer.
    
    Returns:
    
    true if this serializer subclasses from WriterSerializer.
  - serialize
```
public final void serialize(Object o,
                            Object out)
                     throws SerializeException
```
    Serialize the specified object using the specified session.
    
    Parameters:
    
    out - Where to send the output from the serializer.
    
    o - The object to serialize.
    
    Throws:
    
    SerializeException - If a problem occurred trying to convert the output.
  - setCurrentProperty
```
protected final void setCurrentProperty(BeanPropertyMeta currentProperty)
```
    Sets the current bean property being serialized for proper error messages.
    
    Parameters:
    
    currentProperty - The current property being serialized.
  - setCurrentClass
```
protected final void setCurrentClass(ClassMeta<?> currentClass)
```
    Sets the current class being serialized for proper error messages.
    
    Parameters:
    
    currentClass - The current class being serialized.
  - getJavaMethod
```
protected final Method getJavaMethod()
```
    Returns the Java method that invoked this serializer.
    When using the REST API, this is the Java method invoked by the REST call. Can be used to access annotations defined on the method or class.
    
    Returns:
    
    The Java method that invoked this serializer.
  - getUriResolver
```
protected final UriResolver getUriResolver()
```
    Returns the URI resolver.
    
    Returns:
    
    The URI resolver.
  - getMaxDepth
```
protected final int getMaxDepth()
```
    Returns the Serializer.SERIALIZER_maxDepth setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_maxDepth setting value for this session.
  - getInitialDepth
```
protected final int getInitialDepth()
```
    Returns the Serializer.SERIALIZER_initialDepth setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_initialDepth setting value for this session.
  - isDetectRecursions
```
protected final boolean isDetectRecursions()
```
    Returns the Serializer.SERIALIZER_detectRecursions setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_detectRecursions setting value for this session.
  - isIgnoreRecursions
```
protected final boolean isIgnoreRecursions()
```
    Returns the Serializer.SERIALIZER_ignoreRecursions setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_ignoreRecursions setting value for this session.
  - isUseWhitespace
```
protected boolean isUseWhitespace()
```
    Returns the Serializer.SERIALIZER_useWhitespace setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_useWhitespace setting value for this session.
  - getMaxIndent
```
protected int getMaxIndent()
```
    Returns the Serializer.SERIALIZER_maxIndent setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_maxIndent setting value for this session.
  - isAddBeanTypeProperties
```
protected boolean isAddBeanTypeProperties()
```
    Returns the Serializer.SERIALIZER_addBeanTypeProperties setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_addBeanTypeProperties setting value for this session.
  - getQuoteChar
```
protected char getQuoteChar()
```
    Returns the Serializer.SERIALIZER_quoteChar setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_quoteChar setting value for this session.
  - isTrimNulls
```
protected final boolean isTrimNulls()
```
    Returns the Serializer.SERIALIZER_trimNullProperties setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_trimNullProperties setting value for this session.
  - isTrimEmptyCollections
```
protected final boolean isTrimEmptyCollections()
```
    Returns the Serializer.SERIALIZER_trimEmptyCollections setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_trimEmptyCollections setting value for this session.
  - isTrimEmptyMaps
```
protected final boolean isTrimEmptyMaps()
```
    Returns the Serializer.SERIALIZER_trimEmptyMaps setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_trimEmptyMaps setting value for this session.
  - isTrimStrings
```
protected boolean isTrimStrings()
```
    Returns the Serializer.SERIALIZER_trimStrings setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_trimStrings setting value for this session.
  - isSortCollections
```
protected final boolean isSortCollections()
```
    Returns the Serializer.SERIALIZER_sortCollections setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_sortCollections setting value for this session.
  - isSortMaps
```
protected final boolean isSortMaps()
```
    Returns the Serializer.SERIALIZER_sortMaps setting value for this session.
    
    Returns:
    
    The Serializer.SERIALIZER_sortMaps setting value for this session.
  - push
```
protected final ClassMeta<?> push(String attrName,
                                  Object o,
                                  ClassMeta<?> eType)
                           throws SerializeException
```
    Push the specified object onto the stack.
    
    Parameters:
    
    attrName - The attribute name.
    
    o - The current object being serialized.
    
    eType - The expected class type.
    
    Returns:
    
    The ClassMeta of the object so that instanceof operations only need to be performed once (since they can be expensive).
    
    Throws:
    
    SerializeException - If recursion occurred.
  - willRecurse
```
protected final boolean willRecurse(String attrName,
                                    Object o,
                                    ClassMeta<?> cm)
                             throws SerializeException
```
    Returns true if Serializer.SERIALIZER_detectRecursions is enabled, and the specified object is already higher up in the serialization chain.
    
    Parameters:
    
    attrName - The bean property attribute name, or some other identifier.
    
    o - The object to check for recursion.
    
    cm - The metadata on the object class.
    
    Returns:
    
    true if recursion detected.
    
    Throws:
    
    SerializeException - If recursion occurred.
  - pop
```
protected final void pop()
```
    Pop an object off the stack.
  - onBeanGetterException
```
protected final void onBeanGetterException(BeanPropertyMeta p,
                                           Throwable t)
```
    Specialized warning when an exception is thrown while executing a bean getter.
    
    Parameters:
    
    p - The bean map entry representing the bean property.
    
    t - The throwable that the bean getter threw.
  - onError
```
protected final void onError(Throwable t,
                             String msg,
                             Object... args)
```
    Logs a warning message.
    
    Parameters:
    
    t - The throwable that was thrown (if there was one).
    
    msg - The warning message.
    
    args - Optional MessageFormat-style arguments.
  - trim
```
protected final String trim(Object o)
```
    Trims the specified string if isTrimStrings() returns true.
    
    Parameters:
    
    o - The input string to trim.
    
    Returns:
    
    The trimmed string, or null if the input was null.
  - generalize
```
protected final Object generalize(Object o,
                                  ClassMeta<?> type)
                           throws SerializeException
```
    Generalize the specified object if a POJO swap is associated with it.
    
    Parameters:
    
    o - The object to generalize.
    
    type - The type of object.
    
    Returns:
    
    The generalized object, or null if the object is null.
    
    Throws:
    
    SerializeException - If a problem occurred trying to convert the output.
  - canIgnoreValue
```
protected final boolean canIgnoreValue(ClassMeta<?> cm,
                                       String attrName,
                                       Object value)
                                throws SerializeException
```
    Returns true if the specified value should not be serialized.
    
    Parameters:
    
    cm - The class type of the object being serialized.
    
    attrName - The bean attribute name, or null if this isn't a bean attribute.
    
    value - The object being serialized.
    
    Returns:
    
    true if the specified value should not be serialized.
    
    Throws:
    
    SerializeException - If recursion occurred.
  - sort
```
protected final <K,V> Map<K,V> sort(Map<K,V> m)
```
    Sorts the specified map if isSortMaps() returns true.
    
    Parameters:
    
    m - The map being sorted.
    
    Returns:
    
    A new sorted TreeMap.
  - sort
```
protected final <E> Collection<E> sort(Collection<E> c)
```
    Sorts the specified collection if isSortCollections() returns true.
    
    Parameters:
    
    c - The collection being sorted.
    
    Returns:
    
    A new sorted TreeSet.
  - toList
```
protected static final List<Object> toList(Class<?> type,
                                           Object array)
```
    Converts the contents of the specified object array to a list.
    Works on both object and primitive arrays.
    In the case of multi-dimensional arrays, the outgoing list will contain elements of type n-1 dimension. i.e. if type is int[][] then list will have entries of type int[].
    
    Parameters:
    
    type - The type of array.
    
    array - The array being converted.
    
    Returns:
    
    The array as a list.
  - resolveUri
```
public final String resolveUri(Object uri)
```
    Converts a String to an absolute URI based on the UriContext on this session.
    Parameters:
    uri - The input URI. Can be any of the following:
    
    URI
    URL
    CharSequence
    URI can be any of the following forms:
    
    "foo://foo" - Absolute URI.
    "/foo" - Root-relative URI.
    "/" - Root URI.
    "context:/foo" - Context-root-relative URI.
    "context:/" - Context-root URI.
    "servlet:/foo" - Servlet-path-relative URI.
    "servlet:/" - Servlet-path URI.
    "request:/foo" - Request-path-relative URI.
    "request:/" - Request-path URI.
    "foo" - Path-info-relative URI.
    "" - Path-info URI.
    Returns:
    
    The resolved URI.
  - relativizeUri
```
protected final String relativizeUri(Object relativeTo,
                                     Object uri)
```
    Opposite of resolveUri(Object).
    Converts the URI to a value relative to the specified relativeTo parameter.
    Both parameters can be any of the following:
    Both URIs can be any of the following forms:
    - "foo://foo" - Absolute URI.
    - "/foo" - Root-relative URI.
    - "/" - Root URI.
    - "context:/foo" - Context-root-relative URI.
    - "context:/" - Context-root URI.
    - "servlet:/foo" - Servlet-path-relative URI.
    - "servlet:/" - Servlet-path URI.
    - "request:/foo" - Request-path-relative URI.
    - "request:/" - Request-path URI.
    - "foo" - Path-info-relative URI.
    - "" - Path-info URI.
    Parameters:
    
    relativeTo - The URI to relativize against.
    
    uri - The URI to relativize.
    
    Returns:
    
    The relativized URI.
  - toString
```
public final String toString(Object o)
```
    Converts the specified object to a String.
    Also has the following effects:
    - Class object is converted to a readable name. See ClassUtils.getReadableClassName(Class).
    - Whitespace is trimmed if the trim-strings setting is enabled.
    Parameters:
    
    o - The object to convert to a String.
    
    Returns:
    
    The object converted to a String, or null if the input was null.
  - getLastLocation
```
protected final ObjectMap getLastLocation()
```
    Returns information used to determine at what location in the parse a failure occurred.
    
    Returns:
    
    A map, typically containing something like {line:123,column:456,currentProperty:"foobar"}
  - createBeanTypeNameProperty
```
protected static final BeanPropertyValue createBeanTypeNameProperty(BeanMap<?> m,
                                                                    String typeName)
```
    Create a "_type" property that contains the dictionary name of the bean.
    
    Parameters:
    
    m - The bean map to create a class property on.
    
    typeName - The type name of the bean.
    
    Returns:
    
    A new bean property value.
  - getBeanTypeName
```
protected final String getBeanTypeName(ClassMeta<?> eType,
                                       ClassMeta<?> aType,
                                       BeanPropertyMeta pMeta)
```
    Resolves the dictionary name for the actual type.
    
    Parameters:
    
    eType - The expected type of the bean property.
    
    aType - The actual type of the bean property.
    
    pMeta - The current bean property being serialized.
    
    Returns:
    
    The bean dictionary name, or null if a name could not be found.
  - getExpectedRootType
```
protected final ClassMeta<?> getExpectedRootType(Object o)
```
    Returns the parser-side expected type for the object.
    The return value depends on the Serializer.SERIALIZER_abridged setting. When enabled, the parser already knows the Java POJO type being parsed, so there is no reason to add "_type" attributes to the root-level object.
    
    Parameters:
    
    o - The object to get the expected type on.
    
    Returns:
    
    The expected type.
  - getResponseHeaders
```
public Map<String,String> getResponseHeaders()
```
    Optional method that specifies HTTP request headers for this serializer.
    For example, SoapXmlSerializer needs to set a SOAPAction header.
    This method is typically meaningless if the serializer is being used stand-alone (i.e. outside of a REST server or client).
    
    Returns:
    
    The HTTP headers to set on HTTP requests. Never null.
  - getListener
```
public SerializerListener getListener()
```
    Returns the listener associated with this session.
    
    Returns:
    
    The listener associated with this session, or null if there is no listener.
  - getListener
```
public <T extends SerializerListener> T getListener(Class<T> c)
```
    Returns the listener associated with this session.
    
    Parameters:
    
    c - The listener class to cast to.
    
    Returns:
    
    The listener associated with this session, or null if there is no listener.

Class SerializerSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.BeanSession

Methods inherited from class org.apache.juneau.Session

Methods inherited from class java.lang.Object

Field Detail

indent

Constructor Detail

SerializerSession

SerializerSession

Method Detail

asMap

createPipe

doSerialize

serialize

isWriterSerializer

serialize

setCurrentProperty

setCurrentClass

getJavaMethod

getUriResolver

getMaxDepth

getInitialDepth

isDetectRecursions

isIgnoreRecursions

isUseWhitespace

getMaxIndent

isAddBeanTypeProperties

getQuoteChar

isTrimNulls

isTrimEmptyCollections

isTrimEmptyMaps

isTrimStrings

isSortCollections

isSortMaps

push

willRecurse

pop

onBeanGetterException

onError

trim

generalize

canIgnoreValue

sort

sort

toList

resolveUri

relativizeUri

toString

getLastLocation

createBeanTypeNameProperty

getBeanTypeName

getExpectedRootType

getResponseHeaders

getListener

getListener