Package org.apache.juneau.html

Class HtmlStrippedDocSerializer

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.xml.XmlSerializer

org.apache.juneau.html.HtmlSerializer

org.apache.juneau.html.HtmlStrippedDocSerializer

All Implemented Interfaces:

AnnotationProvider, HtmlMetaProvider, XmlMetaProvider

Direct Known Subclasses:

HtmlDocSerializer

public class HtmlStrippedDocSerializer
extends HtmlSerializer

Serializes POJOs to HTTP responses as stripped HTML.

Media types

Handles Accept types: text/html+stripped

Produces Content-Type types: text/html

Description

Produces the same output as HtmlDocSerializer, but without the header and body tags and page title and description. Used primarily for JUnit testing the HtmlDocSerializer class.

Notes:

• This class is thread safe and reusable.

See Also:

• HTML Basics

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.html.HtmlSerializer

HtmlSerializer.Sq, HtmlSerializer.SqReadable

Nested classes/interfaces inherited from class org.apache.juneau.xml.XmlSerializer

XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable

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

Serializer.Null

Field Summary

Fields

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

Fields inherited from class org.apache.juneau.html.HtmlSerializer

DEFAULT_SIMPLE_SQ, DEFAULT_SQ, DEFAULT_SQ_READABLE

Fields inherited from class org.apache.juneau.xml.XmlSerializer

DEFAULT_JUNEAU_NAMESPACE, DEFAULT_NS, DEFAULT_NS_SQ, DEFAULT_NS_SQ_READABLE, DEFAULT_XS_NAMESPACE

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
HtmlStrippedDocSerializer(HtmlStrippedDocSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
HtmlStrippedDocSerializer.Builder	copy()	Creates a builder from this context object.
static HtmlStrippedDocSerializer.Builder	create()	Creates a new builder for this object.
HtmlStrippedDocSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
HtmlStrippedDocSerializerSession	getSession()	Returns a session to use for this context.

Methods inherited from class org.apache.juneau.html.HtmlSerializer

getHtmlBeanPropertyMeta, getHtmlClassMeta, getLabelParameter, getSchemaSerializer, getUriAnchorText, isAddBeanTypes, isAddKeyValueTableHeaders, isDetectLabelParameters, isDetectLinksInStrings, properties

Methods inherited from class org.apache.juneau.xml.XmlSerializer

getDefaultNamespace, getNamespaces, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, isAddNamespaceUrlsToRoot, isAutoDetectNamespaces, isEnableNamespaces

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

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

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

createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, 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 HtmlStrippedDocSerializer DEFAULT

Default serializer, all default settings.

Constructor Details

HtmlStrippedDocSerializer

public HtmlStrippedDocSerializer(HtmlStrippedDocSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlStrippedDocSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public HtmlStrippedDocSerializer.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 HtmlSerializer

Returns:

A new Builder object.

createSession

public HtmlStrippedDocSerializerSession.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 HtmlSerializer

Returns:

A new session builder.

getSession

public HtmlStrippedDocSerializerSession 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 HtmlSerializer

Returns:

A new session object.