Package org.apache.juneau.plaintext

Class PlainTextSerializer

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

org.apache.juneau.plaintext.PlainTextSerializer

All Implemented Interfaces:

AnnotationProvider, PlainTextMetaProvider

public class PlainTextSerializer
extends WriterSerializer
implements PlainTextMetaProvider

Serializes POJOs to plain text using just the toString() method on the serialized object.

Media types

Handles Accept types: text/plain

Produces Content-Type types: text/plain

Description

Essentially converts POJOs to plain text using the toString() method.

Also serializes objects using a transform if the object class has an ObjectSwap<?,String> transform defined on it.

Notes:

• This class is thread safe and reusable.

See Also:

Nested Class Summary

Nested Classes

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

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

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final PlainTextSerializer	DEFAULT	Default serializer, all default settings.

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Constructor	Description
PlainTextSerializer(PlainTextSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
PlainTextSerializer.Builder	copy()	Creates a builder from this context object.
static PlainTextSerializer.Builder	create()	Creates a new builder for this object.
PlainTextSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
PlainTextBeanPropertyMeta	getPlainTextBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
PlainTextClassMeta	getPlainTextClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
PlainTextSerializerSession	getSession()	Returns a session to use for this context.

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

getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, properties, quoteChar, serialize, toString

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

Methods inherited from interface org.apache.juneau.AnnotationProvider

firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation

Field Details

DEFAULT

public static final PlainTextSerializer DEFAULT

Default serializer, all default settings.

Constructor Details

PlainTextSerializer

public PlainTextSerializer(PlainTextSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static PlainTextSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

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

Returns:

A new Builder object.

createSession

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

Returns:

A new session builder.

getSession

public PlainTextSerializerSession 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 WriterSerializer

Returns:

A new session object.

getPlainTextClassMeta

public PlainTextClassMeta getPlainTextClassMeta(ClassMeta<?> cm)

Description copied from interface: PlainTextMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getPlainTextClassMeta in interface PlainTextMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getPlainTextBeanPropertyMeta

public PlainTextBeanPropertyMeta getPlainTextBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: PlainTextMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getPlainTextBeanPropertyMeta in interface PlainTextMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.