Package org.apache.juneau.marshall.serializer

Class WriterSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

org.apache.juneau.marshall.serializer.Serializer

org.apache.juneau.marshall.serializer.WriterSerializer

All Implemented Interfaces:

Function<Object,String>, ThrowingFunction<Object,String>

Direct Known Subclasses:

CsvSerializer, HjsonSerializer, HoconSerializer, IniSerializer, JsonSerializer, MarkdownSerializer, PlainTextSerializer, RdfSerializer, SseSerializer, TomlSerializer, UonSerializer, XmlSerializer, YamlSerializer

public class WriterSerializer
extends Serializer
implements ThrowingFunction<Object,String>

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<SELF extends WriterSerializer.Builder<SELF>>	Builder class.
static final class	WriterSerializer.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() / copy() path.

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

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	maxIndent
protected final Character	quoteChar
protected final Character	quoteCharOverride
protected final boolean	useWhitespace

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

accept, addBeanTypes, addRootType, keepNullProperties, listener, nonDefault, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriterSerializer(WriterSerializer.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
final String	applyThrows(Object o)	Allows this serializer to be used as a ThrowingFunction that converts an object to its serialized string form.
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 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()	Use whitespace.
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 FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
protected Character	quoteChar()	Quote character.
final String	toString(Object o)	Identical to write(Object) except throws a RuntimeException instead of a SerializeException.
final String	write(Object o)	Convenience method for serializing an object to a String.

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

createSerializerBuilder, doWrite, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, write, writeToString

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions, shouldDetectRecursions

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.apache.juneau.commons.function.ThrowingFunction

apply

Field Details

useWhitespace

protected final boolean useWhitespace

quoteChar

protected final Character quoteChar

quoteCharOverride

protected final Character quoteCharOverride

maxIndent

protected final int maxIndent

Constructor Details

WriterSerializer

protected WriterSerializer(WriterSerializer.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.
Cannot be null.

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.

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.

write

public final String write(Object o)
                   throws SerializeException

Convenience method for serializing an object to a String.

Overrides:

write 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.

applyThrows

public final String applyThrows(Object o)
                         throws Exception

Allows this serializer to be used as a ThrowingFunction that converts an object to its serialized string form.

Because WriterSerializer implements ThrowingFunction<Object,String>, a serializer instance can be passed directly wherever a Function or ThrowingFunction is expected (e.g. assertion transform methods).

Example:

assertObject(myPojo).asString(Json5Serializer.DEFAULT).is("{...}");

Specified by:

applyThrows in interface ThrowingFunction<Object,String>

Parameters:

o - The object to serialize.

Returns:

The output serialized to a string.

Throws:

Exception - If a problem occurred trying to convert the output.

toString

public final String toString(Object o)

Identical to write(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.

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)

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()

Use whitespace.

Returns:

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

See Also:

• WriterSerializer.Builder.useWhitespace()

properties

protected FluentMap<String,Object> 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.

quoteChar

protected Character quoteChar()

Quote character.

Returns:

The character used for quoting attributes and values.

See Also:

• WriterSerializer.Builder.quoteChar(char)