WriterSerializer (Apache Juneau 8.1.2)

java.lang.Object
- org.apache.juneau.Context
- - org.apache.juneau.BeanContext
  - - org.apache.juneau.BeanTraverseContext
    - - org.apache.juneau.serializer.Serializer
      - org.apache.juneau.serializer.WriterSerializer

Direct Known Subclasses:

CsvSerializer, JsonSerializer, PlainTextSerializer, RdfSerializer, UonSerializer, XmlSerializer
```
@ConfigurableContext
public abstract class WriterSerializer
extends Serializer
```
Subclass of Serializer for character-based serializers.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`WSERIALIZER_fileCharset` Configuration property: File charset.
`static String`	`WSERIALIZER_maxIndent` Configuration property: Maximum indentation.
`static String`	`WSERIALIZER_quoteChar` Configuration property: Quote character.
`static String`	`WSERIALIZER_streamCharset` Configuration property: Output stream charset.
`static String`	`WSERIALIZER_useWhitespace` Configuration property: Use whitespace.

Fields inherited from class org.apache.juneau.serializer.Serializer
SERIALIZER_addBeanTypes, SERIALIZER_addRootType, SERIALIZER_listener, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution

Fields inherited from class org.apache.juneau.BeanTraverseContext
BEANTRAVERSE_detectRecursions, BEANTRAVERSE_ignoreRecursions, BEANTRAVERSE_initialDepth, BEANTRAVERSE_maxDepth

Fields inherited from class org.apache.juneau.BeanContext
BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors
Modifier Constructor and Description

protected WriterSerializer(PropertyStore ps, String produces, String accept)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`WriterSerializer(PropertyStore ps, String produces, String accept)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`WriterSerializerSession`	`createSession()` Create a new bean session based on the properties defined on this context.
`abstract WriterSerializerSession`	`createSession(SerializerSessionArgs args)` Create the session object used for actual serialization of objects.
`protected Charset`	`getFileCharset()` Configuration property: File charset.
`protected int`	`getMaxIndent()` Configuration property: Maximum indentation.
`protected char`	`getQuoteChar()` Configuration property: Quote character.
`protected Charset`	`getStreamCharset()` Configuration property: Output stream charset.
`protected boolean`	`isUseWhitespace()` Configuration property: Trim strings.
`boolean`	`isWriterSerializer()` Returns true if this serializer subclasses from `WriterSerializer`.
`WriterSerializer`	`println(Object o)` Convenience method for serializing an object and sending it to STDOUT.
`String`	`serialize(Object o)` Convenience method for serializing an object to a String.
`ObjectMap`	`toMap()` Returns the properties defined on this bean context as a simple map for debugging purposes.
`String`	`toString(Object o)` Identical to `serialize(Object)` except throws a `RuntimeException` instead of a `SerializeException`.
`StringObject`	`toStringObject(Object o)` Wraps the specified object inside a `StringObject`.

Methods inherited from class org.apache.juneau.serializer.Serializer
builder, createDefaultSessionArgs, getAcceptMediaTypes, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNullProperties, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext
createSession, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContext
_class, create, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getImplClassConstructor, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

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

- Field Detail
  - WSERIALIZER_fileCharset
```
public static final String WSERIALIZER_fileCharset
```
    Configuration property: File charset.
    Property:
    - Name: "WriterSerializer.fileCharset.s"
    - Data type: String
    - Default: "DEFAULT"
    - Session property: false
    - Methods:
      
      WriterSerializerBuilder.fileCharset(Charset)
    Description:
    
    The character set to use for writing Files to the file system.
    Used when passing in files to Serializer.serialize(Object, Object).
    "DEFAULT" can be used to indicate the JVM default file system charset.
    Example:
    
    // Create a serializer that writes UTF-8 files. WriterSerializer s = JsonSerializer. .create() .fileCharset(Charset.forName("UTF-8")) .build(); // Same, but use property. WriterSerializer s = JsonSerializer. .create() .set(WSERIALIZER_fileCharset, "UTF-8") .build(); // Use it to read a UTF-8 encoded file. s.serialize(new File("MyBean.txt"), myBean);
    See Also:
    
    Constant Field Values
  - WSERIALIZER_maxIndent
```
public static final String WSERIALIZER_maxIndent
```
    Configuration property: Maximum indentation.
    Property:
    - Name: "WriterSerializer.maxIndent.i"
    - Data type: Integer
    - Default: 100
    - Session property: false
    - Methods:
      
      WriterSerializerBuilder.maxIndent(int)
    Description:
    
    Specifies the maximum indentation level in the serialized document.
    This setting does not apply to the RDF serializers.
    Example:
    
    // Create a serializer that indents a maximum of 20 tabs. WriterSerializer s = JsonSerializer .create() .maxIndent(20) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_maxIndent, 20) .build();
    See Also:
    
    Constant Field Values
  - WSERIALIZER_quoteChar
```
public static final String WSERIALIZER_quoteChar
```
    Configuration property: Quote character.
    Property:
    - Name: "WriterSerializer.quoteChar.s"
    - Data type: String
    - Default: "\""
    - Session property: false
    - Methods:
      
      WriterSerializerBuilder.quoteChar(char)
      WriterSerializerBuilder.sq()
    Description:
    
    This is the character used for quoting attributes and values.
    This setting does not apply to the RDF serializers.
    Example:
    
    // Create a serializer that uses single quotes. WriterSerializer s = JsonSerializer .create() .sq() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(WSERIALIZER_quoteChar, '\'') .build();
    See Also:
    
    Constant Field Values
  - WSERIALIZER_streamCharset
```
public static final String WSERIALIZER_streamCharset
```
    Configuration property: Output stream charset.
    Property:
    - Name: "WriterSerializer.streamCharset.s"
    - Data type: String
    - Default: "UTF-8"
    - Session property: false
    - Methods:
      
      WriterSerializerBuilder.streamCharset(Charset)
    Description:
    
    The character set to use when writing to OutputStreams.
    Used when passing in output streams and byte arrays to Serializer.serialize(Object, Object).
    Example:
    
    // Create a serializer that writes UTF-8 files. WriterSerializer s = JsonSerializer. .create() .streamCharset(Charset.forName("UTF-8")) .build(); // Same, but use property. WriterSerializer s = JsonSerializer. .create() .set(WSERIALIZER_streamCharset, "UTF-8") .build(); // Use it to write to a UTF-8 encoded output stream. s.serializer(new FileOutputStreamStream("MyBean.txt"), myBean);
    See Also:
    
    Constant Field Values
  - WSERIALIZER_useWhitespace
```
public static final String WSERIALIZER_useWhitespace
```
    Configuration property: Use whitespace.
    Property:
    - Name: "WriterSerializer.useWhitespace.b"
    - Data type: Boolean
    - Default: false
    - Session property: true
    - Methods:
      
      WriterSerializerBuilder.useWhitespace(boolean)
      WriterSerializerBuilder.useWhitespace()
      WriterSerializerBuilder.ws()
    Description:
    
    If true, whitespace is added to the output to improve readability.
    Example:
    
    // Create a serializer with whitespace enabled. WriterSerializer s = JsonSerializer .create() .ws() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(WSERIALIZER_useWhitespace, true) .build(); // Produces "\{\n\t'foo': 'bar'\n\}\n" String json = s.serialize(new MyBean());
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WriterSerializer
```
protected WriterSerializer(PropertyStore ps,
                           String produces,
                           String accept)
```
    Constructor.
    
    Parameters:
    
    ps - The property store containing all the settings for this object.
    
    produces - The media type that this serializer produces.
    
    accept - The accept media types that the serializer can handle.
    Can contain meta-characters per the media-type specification of RFC2616/14.1
    If empty, then assumes the only media type supported is produces.
    For example, if this serializer produces "application/json" but should handle media types of "application/json" and "text/json", then the arguments should be:
    super(ps, "application/json", "application/json,text/json");
    
    ...or...
    super(ps, "application/json", "*/json");
    
    The accept value can also contain q-values.
- Method Detail
  - createSession
```
public abstract WriterSerializerSession createSession(SerializerSessionArgs args)
```
    Description copied from class: Serializer
    
    Create the session object used for actual serialization of objects.
    
    Specified by:
    
    createSession in class Serializer
    
    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.
    
    Returns:
    
    The new session object.
  - createSession
```
public WriterSerializerSession createSession()
```
    Description copied from class: BeanContext
    
    Create a new bean session based on the properties defined on this context.
    Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.
    
    Overrides:
    
    createSession in class Serializer
    
    Returns:
    
    A new session object.
  - isWriterSerializer
```
public final boolean isWriterSerializer()
```
    Description copied from class: Serializer
    
    Returns true if this serializer subclasses from WriterSerializer.
    
    Overrides:
    
    isWriterSerializer in class Serializer
    
    Returns:
    
    true if this serializer subclasses from WriterSerializer.
  - serialize
```
public final String serialize(Object o)
                       throws SerializeException
```
    Convenience method for serializing an object to a String.
    
    Overrides:
    
    serialize in class Serializer
    
    Parameters:
    
    o - The object to serialize.
    
    Returns:
    
    The output serialized to a string.
    
    Throws:
    
    SerializeException - If a problem occurred trying to convert the output.
  - toString
```
public final String toString(Object o)
```
    Identical to serialize(Object) except throws a RuntimeException instead of a SerializeException.
    This is typically good enough for debugging purposes.
    
    Parameters:
    
    o - The object to serialize.
    
    Returns:
    
    The serialized object.
  - toStringObject
```
public final StringObject toStringObject(Object o)
```
    Wraps the specified object inside a StringObject.
    
    Parameters:
    
    o - The object to wrap.
    
    Returns:
    
    The wrapped object.
  - println
```
public final WriterSerializer println(Object o)
```
    Convenience method for serializing an object and sending it to STDOUT.
    
    Parameters:
    
    o - The object to serialize.
    
    Returns:
    
    This object (for method chaining).
  - getFileCharset
```
protected final Charset getFileCharset()
```
    Configuration property: File charset.
    
    Returns:
    
    The character set to use when writing to Files on the file system.
    
    See Also:
    
    WSERIALIZER_fileCharset
  - getMaxIndent
```
protected final int getMaxIndent()
```
    Configuration property: Maximum indentation.
    
    Returns:
    
    The maximum indentation level in the serialized document.
    
    See Also:
    
    WSERIALIZER_maxIndent
  - getQuoteChar
```
protected final char getQuoteChar()
```
    Configuration property: Quote character.
    
    Returns:
    
    The character used for quoting attributes and values.
    
    See Also:
    
    WSERIALIZER_quoteChar
  - getStreamCharset
```
protected final Charset getStreamCharset()
```
    Configuration property: Output stream charset.
    
    Returns:
    
    The character set to use when writing to OutputStreams and byte arrays.
    
    See Also:
    
    WSERIALIZER_streamCharset
  - isUseWhitespace
```
protected final boolean isUseWhitespace()
```
    Configuration property: Trim strings.
    
    Returns:
    
    If true, whitespace is added to the output to improve readability.
    
    See Also:
    
    WSERIALIZER_useWhitespace
  - toMap
```
public ObjectMap toMap()
```
    Description copied from class: Context
    
    Returns the properties defined on this bean context as a simple map for debugging purposes.
    
    Overrides:
    
    toMap in class Serializer
    
    Returns:
    
    A new map containing the properties defined on this context.

Class WriterSerializer

Field Summary

Fields inherited from class org.apache.juneau.serializer.Serializer

Fields inherited from class org.apache.juneau.BeanTraverseContext

Fields inherited from class org.apache.juneau.BeanContext

Constructor Summary

Method Summary

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

Methods inherited from class org.apache.juneau.BeanTraverseContext

Methods inherited from class org.apache.juneau.BeanContext

Methods inherited from class org.apache.juneau.Context

Methods inherited from class java.lang.Object

Field Detail

WSERIALIZER_fileCharset

Property:

Description:

Example:

WSERIALIZER_maxIndent

Property:

Description:

Example:

WSERIALIZER_quoteChar

Property:

Description:

Example:

WSERIALIZER_streamCharset

Property:

Description:

Example:

WSERIALIZER_useWhitespace

Property:

Description:

Example:

Constructor Detail

WriterSerializer

Method Detail

createSession

createSession

isWriterSerializer

serialize

toString

toStringObject

println

getFileCharset

getMaxIndent

getQuoteChar

getStreamCharset

isUseWhitespace

toMap