Package org.apache.juneau.marshall.html

Class HtmlSchemaDocSerializer

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

org.apache.juneau.marshall.xml.XmlSerializer

org.apache.juneau.marshall.html.HtmlSerializer

org.apache.juneau.marshall.html.HtmlStrippedDocSerializer

org.apache.juneau.marshall.html.HtmlDocSerializer

org.apache.juneau.marshall.html.HtmlSchemaDocSerializer

All Implemented Interfaces:

Function<Object,String>, ThrowingFunction<Object,String>, HtmlMetaProvider, RecordWritable, XmlMetaProvider

public class HtmlSchemaDocSerializer
extends HtmlDocSerializer

Serializes POJO metamodels to HTML.

Media types

Handles Accept types: text/html+schema

Produces Content-Type types: text/html

Description

Essentially the same as HtmlDocSerializer, except serializes the POJO metamodel instead of the model itself.

Produces output that describes the POJO metamodel similar to an XML schema document.

The easiest way to create instances of this class is through the HtmlSerializer.getSchemaSerializer(), which will create a schema serializer with the same settings as the originating serializer.

Notes:

• This class is thread safe and reusable.

See Also:

• HTML

Nested Class Summary

Nested Classes

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

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

HtmlDocSerializer.DefaultBuilder

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

HtmlSerializer.Sq, HtmlSerializer.SqReadable

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

XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable

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

Serializer.Null

Field Summary

Fields inherited from class org.apache.juneau.marshall.html.HtmlDocSerializer

DEFAULT

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

addBeanTypesHtml, addKeyValueTableHeaders, DEFAULT_SIMPLE_SQ, DEFAULT_SQ, DEFAULT_SQ_READABLE, detectLabelParameters, detectLinksInStrings, labelParameter, uriAnchorText

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

addBeanTypesXml, addJsonTags, addNamespaceUrlsToRoot, autoDetectNamespaces, DEFAULT_JUNEAU_NAMESPACE, DEFAULT_NS, DEFAULT_NS_SQ, DEFAULT_NS_SQ_READABLE, enableNamespaces

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

maxIndent, quoteChar, quoteCharOverride, 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

Constructor	Description
HtmlSchemaDocSerializer(HtmlDocSerializer.Builder<?> builder)	Constructor.

Method Summary

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

Methods inherited from class org.apache.juneau.marshall.html.HtmlDocSerializer

forEachWidget, getAside, getAsideFloat, getFooter, getHead, getHeader, getNav, getNavlinks, getNoResultsMessage, getSchemaSerializer, getScript, getStyle, getStylesheet, getTemplate, getWidgets, isNowrap, properties

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

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

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

getDefaultNamespace, getNamespaces, getTextNodeDelimiter, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, isAddNamespaceUrlsToRoot, isAutoDetectNamespaces, isEnableNamespaces, isRecordStreaming, writeRecords

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

applyThrows, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, toString, write

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

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

Constructor Details

HtmlSchemaDocSerializer

public HtmlSchemaDocSerializer(HtmlDocSerializer.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlSchemaDocSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public HtmlSchemaDocSerializer.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 HtmlDocSerializer

Returns:

A new Builder object.

createSession

public HtmlSchemaDocSerializerSession.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 HtmlDocSerializer

Returns:

A new session builder.

getSession

public HtmlSchemaDocSerializerSession 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 HtmlDocSerializer

Returns:

A new session object.