Package org.apache.juneau.marshall.html

Class HtmlSchemaDocSerializer.Builder

java.lang.Object

org.apache.juneau.marshall.Context.Builder<SELF>

org.apache.juneau.marshall.MarshallingContextable.Builder<SELF>

org.apache.juneau.marshall.MarshallingTraverseContext.Builder<SELF>

org.apache.juneau.marshall.serializer.Serializer.Builder<SELF>

org.apache.juneau.marshall.serializer.WriterSerializer.Builder<SELF>

org.apache.juneau.marshall.xml.XmlSerializer.Builder<SELF>

org.apache.juneau.marshall.html.HtmlSerializer.Builder<SELF>

org.apache.juneau.marshall.html.HtmlStrippedDocSerializer.Builder<SELF>

org.apache.juneau.marshall.html.HtmlDocSerializer.Builder<HtmlSchemaDocSerializer.Builder>

org.apache.juneau.marshall.html.HtmlSchemaDocSerializer.Builder

Enclosing class:

HtmlSchemaDocSerializer

public static class HtmlSchemaDocSerializer.Builder
extends HtmlDocSerializer.Builder<HtmlSchemaDocSerializer.Builder>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor, default settings.
protected	Builder(HtmlSchemaDocSerializer copyFrom)	Copy constructor.
protected	Builder(HtmlSchemaDocSerializer.Builder copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
HtmlSchemaDocSerializer.Builder	addDescriptionsTo(TypeCategory... values)	HtmlSchemaSerializer configuration property:  Add descriptions.
HtmlSchemaDocSerializer.Builder	addExamplesTo(TypeCategory... values)	HtmlSchemaSerializer configuration property:  Add examples.
HtmlSchemaDocSerializer.Builder	allowNestedDescriptions()	HtmlSchemaSerializer configuration property:  Allow nested descriptions.
HtmlSchemaDocSerializer.Builder	allowNestedExamples()	HtmlSchemaSerializer configuration property:  Allow nested examples.
HtmlSchemaDocSerializer.Builder	beanDefMapper(Class<? extends MarshallingDefMapper> value)	HtmlSchemaSerializer configuration property:  Schema definition mapper.
HtmlSchemaDocSerializer	build()	Build the object.
HtmlSchemaDocSerializer.Builder	copy()	Copy creator.
HtmlSchemaDocSerializer.Builder	useBeanDefs()	HtmlSchemaSerializer configuration property:  Use bean definitions.
HtmlSchemaDocSerializer.Builder	widgets(Class<? extends HtmlWidget>... values)	HTML Widgets.

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

aside, aside, asideFloat, footer, footer, hashKey, head, head, header, header, nav, nav, navlinks, navlinks, noResultsMessage, nowrap, nowrap, resolveBodyVars, resolveBodyVars, script, script, style, style, stylesheet, stylesheet, template, widgets

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

addBeanTypesHtml, addBeanTypesHtml, addKeyValueTableHeaders, addKeyValueTableHeaders, disableDetectLabelParameters, disableDetectLabelParameters, disableDetectLinksInStrings, disableDetectLinksInStrings, labelParameter, uriAnchorText

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

addBeanTypesXml, addBeanTypesXml, addNamespaceUrisToRoot, addNamespaceUrisToRoot, defaultNamespace, disableAutoDetectNamespaces, disableAutoDetectNamespaces, disableJsonTags, disableJsonTags, enableNamespaces, enableNamespaces, namespaces, ns, textNodeDelimiter

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

maxIndent, quoteChar, quoteCharOverride, sq, streamCharset, useWhitespace, useWhitespace, ws

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

accept, addBeanTypes, addBeanTypes, addRootType, addRootType, getAccept, getProduces, keepNullProperties, keepNullProperties, listener, nonDefault, nonDefault, produces, sortCollections, sortCollections, sortMaps, sortMaps, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimStrings, trimStrings, uriContext, uriRelativity, uriResolution

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

detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, maxDepth

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

activeView, annotations, beanClassVisibility, beanConstructorVisibility, beanDictionary, beanFieldVisibility, beanInterceptor, beanMapPutReturnsOldValue, beanMethodVisibility, beanProperties, beanProperties, beanProperties, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beansRequireDefaultConstructor, beansRequireSerializable, beansRequireSettersForGetters, bigNumberFormat, binaryFormat, bitSetFormat, booleanFormat, calendarFormat, classFormat, classLoader, currencyFormat, dateFormat, debug, dictionaryOn, disableBeansRequireSomeProperties, disableDefaultViewInclusion, disableIgnoreMissingSetters, disableIgnoreTransientFields, disableIgnoreUnknownNullBeanProperties, disableInterfaceProxies, durationFormat, enumFormat, example, example, findFluentSetters, findFluentSetters, floatFormat, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnSetters, ignoreUnknownBeanProperties, ignoreUnknownEnumValues, implClass, implClasses, interfaceClass, interfaces, locale, localeFormat, marshallingContext, marshallingContext, marshallingContext, marshallingContext, mediaType, notBeanClasses, notBeanPackages, periodFormat, propertyNamer, propertyNamer, recordComponentOrder, stopClass, swap, swap, swaps, swaps, temporalFormat, timeZone, timeZoneFormat, typeName, typePropertyName, typePropertyName, unsortedProperties, unsortedProperties, useJavaBeanIntrospector, uuidFormat, validateSchema, validateSchema

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

annotations, apply, applyAnnotations, applyAnnotations, asSubtype, build, cache, canApply, copyOrNull, debug, getApplied, getType, impl, isDebug, registerBuilders, self, type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor, default settings.

Builder

protected Builder(HtmlSchemaDocSerializer.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.

Builder

protected Builder(HtmlSchemaDocSerializer copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.

Method Details

addDescriptionsTo

public HtmlSchemaDocSerializer.Builder addDescriptionsTo(TypeCategory... values)

HtmlSchemaSerializer configuration property:  Add descriptions.

Identifies which categories of types that descriptions should be automatically added to generated schemas.

The description is the result of calling ClassInfo.getName().

See Also:

• JsonSchemaGenerator.Builder#addDescriptionsTo(TypeCategory...)

Parameters:

values - The values to add to this setting.
The default is an empty string.

Returns:

This object.

addExamplesTo

public HtmlSchemaDocSerializer.Builder addExamplesTo(TypeCategory... values)

HtmlSchemaSerializer configuration property:  Add examples.

Identifies which categories of types that examples should be automatically added to generated schemas.

The examples come from calling ClassMeta.getExample(MarshallingSession,JsonParserSession) which in turn gets examples from the following:

• Example
• Marshalled(example)

See Also:

• JsonSchemaGenerator.Builder#addExamplesTo(TypeCategory...)

Parameters:

values - The values to add to this setting.
The default is an empty string.

Returns:

This object.

allowNestedDescriptions

public HtmlSchemaDocSerializer.Builder allowNestedDescriptions()

HtmlSchemaSerializer configuration property:  Allow nested descriptions.

Identifies whether nested descriptions are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder#allowNestedDescriptions()

Returns:

This object.

allowNestedExamples

public HtmlSchemaDocSerializer.Builder allowNestedExamples()

HtmlSchemaSerializer configuration property:  Allow nested examples.

Identifies whether nested examples are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder#allowNestedExamples()

Returns:

This object.

beanDefMapper

public HtmlSchemaDocSerializer.Builder beanDefMapper(Class<? extends MarshallingDefMapper> value)

HtmlSchemaSerializer configuration property:  Schema definition mapper.

Interface to use for converting Bean classes to definition IDs and URIs.

Used primarily for defining common definition sections for beans in Swagger JSON.

This setting is ignored if JsonSchemaGenerator.Builder#useBeanDefs() is not enabled.

See Also:

• JsonSchemaGenerator.Builder#beanDefMapper(Class)

Parameters:

value - The new value for this property.
The default is BasicBeanDefMapper.

Returns:

This object.

build

public HtmlSchemaDocSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class HtmlDocSerializer.Builder<HtmlSchemaDocSerializer.Builder>

Returns:

The built object.

copy

public HtmlSchemaDocSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class HtmlDocSerializer.Builder<HtmlSchemaDocSerializer.Builder>

Returns:

A new mutable copy of this builder.

useBeanDefs

public HtmlSchemaDocSerializer.Builder useBeanDefs()

HtmlSchemaSerializer configuration property:  Use bean definitions.

When enabled, schemas on beans will be serialized as the following:

{ type: 'object', '$ref': '#/definitions/TypeId' }

Returns:

This object.

widgets

public HtmlSchemaDocSerializer.Builder widgets(Class<? extends HtmlWidget>... values)

Description copied from class: HtmlDocSerializer.Builder

HTML Widgets.

Defines widgets that can be used in conjunction with string variables of the form "$W{name}"to quickly generate arbitrary replacement text. Widgets resolve the following variables:

• "$W{name}" - Contents returned by HtmlWidget.getHtml(VarResolverSession).
• "$W{name.script}" - Contents returned by HtmlWidget.getScript(VarResolverSession).
  The script contents are automatically inserted into the <head/script> section in the HTML page.
• "$W{name.style}" - Contents returned by HtmlWidget.getStyle(VarResolverSession).
  The styles contents are automatically inserted into the <head/style> section in the HTML page.

The following examples shows how to associate a widget with a REST method and then have it rendered in the links and aside section of the page:

WriterSerializer serializer = HtmlDocSerializer .create() .widgets( MyWidget.class ) .navlinks( "$W{MyWidget}" ) .aside( "Check out this widget: $W{MyWidget}" ) .build();

Notes:

• Widgets are inherited from super classes, but can be overridden by reusing the widget name.

See Also:

• Widgets

Overrides:

widgets in class HtmlDocSerializer.Builder<HtmlSchemaDocSerializer.Builder>

Parameters:

values - The values to add to this setting.

Returns:

This object.