Package org.apache.juneau.serializer

Class WriterSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

All Implemented Interfaces:

AnnotationProvider

Direct Known Subclasses:

CsvSerializer, JsonSerializer, PlainTextSerializer, UonSerializer, XmlSerializer

public class WriterSerializer
extends Serializer

Subclass of Serializer for character-based serializers.

Notes:

• This class is thread safe and reusable.

See Also:

• Serializers and Parsers

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer

Serializer.Null

Field Summary

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DEFAULT, DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
WriterSerializer.Builder	copy()	Creates a builder from this context object.
static WriterSerializer.Builder	create()	Creates a new builder for this object.
WriterSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
protected final Charset	getFileCharset()	File charset.
protected final int	getMaxIndent()	Maximum indentation.
protected char	getQuoteChar()	Quote character.
WriterSerializerSession	getSession()	Returns a session to use for this context.
protected final Charset	getStreamCharset()	Output stream charset.
protected final boolean	isUseWhitespace()	Trim strings.
final boolean	isWriterSerializer()	Returns true if this serializer subclasses from WriterSerializer.
final WriterSerializer	println(Object o)	Convenience method for serializing an object and sending it to STDOUT.
protected JsonMap	properties()	Returns the properties on this bean as a map for debugging.
protected Character	quoteChar()	Quote character.
final String	serialize(Object o)	Convenience method for serializing an object to a String.
final String	toString(Object o)	Identical to serialize(Object) except throws a RuntimeException instead of a SerializeException.

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

createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

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

Constructor Details

WriterSerializer

protected WriterSerializer(WriterSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static WriterSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public WriterSerializer.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 Serializer

Returns:

A new Builder object.

createSession

public WriterSerializerSession.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 Serializer

Returns:

A new session builder.

getSession

public WriterSerializerSession 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 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.

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.

getFileCharset

protected final Charset getFileCharset()

File charset.

Returns:

The character set to use when writing to Files on the file system.

See Also:

• WriterSerializer.Builder.fileCharset(Charset)

getMaxIndent

protected final int getMaxIndent()

Maximum indentation.

Returns:

The maximum indentation level in the serialized document.

See Also:

• WriterSerializer.Builder.maxIndent(int)

getQuoteChar

protected char getQuoteChar()

Quote character.

Returns:

The character used for quoting attributes and values.

See Also:

• WriterSerializer.Builder.quoteChar(char)

quoteChar

protected Character quoteChar()

Quote character.

Returns:

The character used for quoting attributes and values.

See Also:

• WriterSerializer.Builder.quoteChar(char)

getStreamCharset

protected final Charset getStreamCharset()

Output stream charset.

Returns:

The character set to use when writing to OutputStreams and byte arrays.

See Also:

• WriterSerializer.Builder.streamCharset(Charset)

isUseWhitespace

protected final boolean isUseWhitespace()

Trim strings.

Returns:

When enabled, whitespace is added to the output to improve readability.

See Also:

• WriterSerializer.Builder.useWhitespace()

properties

protected JsonMap properties()

Description copied from class: Context

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

Overrides:

properties in class Serializer

Returns:

The properties on this bean as a map for debugging.