Package org.apache.juneau.marshall.markdown

Class MarkdownDocSerializer.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.markdown.MarkdownSerializer.Builder<MarkdownDocSerializer.Builder>

org.apache.juneau.marshall.markdown.MarkdownDocSerializer.Builder

Enclosing class:

MarkdownDocSerializer

public static class MarkdownDocSerializer.Builder
extends MarkdownSerializer.Builder<MarkdownDocSerializer.Builder>

Builder class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MarkdownDocSerializer.Builder	addHorizontalRules(boolean value)	Whether to add horizontal rules (---) between sections.
MarkdownDocSerializer	build()	Build the object.
MarkdownDocSerializer.Builder	copy()	Copy creator.
MarkdownDocSerializer.Builder	footerContent(String value)	Static content appended to the document output.
HashKey	hashKey()	Returns the hashkey of this builder.
MarkdownDocSerializer.Builder	headerContent(String value)	Static content prepended to the document output (e.g.
MarkdownDocSerializer.Builder	headingLevel(int value)	The starting heading level (1-6).
MarkdownDocSerializer.Builder	title(String value)	The document title (rendered as the top-level heading).

Methods inherited from class org.apache.juneau.marshall.markdown.MarkdownSerializer.Builder

nullValue, showHeaders

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(MarkdownDocSerializer.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.
Cannot be null.

Builder

protected Builder(MarkdownDocSerializer copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.
Cannot be null.

Method Details

title

public MarkdownDocSerializer.Builder title(String value)

The document title (rendered as the top-level heading).

Parameters:

value - The title.

Returns:

This object.

headingLevel

public MarkdownDocSerializer.Builder headingLevel(int value)

The starting heading level (1-6).

Default is 1 (# Heading).

Parameters:

value - The heading level.

Returns:

This object.

addHorizontalRules

public MarkdownDocSerializer.Builder addHorizontalRules(boolean value)

Whether to add horizontal rules (---) between sections.

Parameters:

value - Whether to add horizontal rules.

Returns:

This object.

headerContent

public MarkdownDocSerializer.Builder headerContent(String value)

Static content prepended to the document output (e.g. YAML front matter).

Parameters:

value - The header content.

Returns:

This object.

footerContent

public MarkdownDocSerializer.Builder footerContent(String value)

Static content appended to the document output.

Parameters:

value - The footer content.

Returns:

This object.

hashKey

public HashKey hashKey()

Description copied from class: Context.Builder

Returns the hashkey of this builder.

Used to return previously instantiated context beans that have matching hashkeys. The HashKey object is suitable for use as a hashmap key of a map of context beans. A context bean is considered equivalent if the HashKey.equals(Object) method is the same.

Overrides:

hashKey in class MarkdownSerializer.Builder<MarkdownDocSerializer.Builder>

Returns:

The hashkey of this builder.

build

public MarkdownDocSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class MarkdownSerializer.Builder<MarkdownDocSerializer.Builder>

Returns:

The built object.

copy

public MarkdownDocSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class MarkdownSerializer.Builder<MarkdownDocSerializer.Builder>

Returns:

A new mutable copy of this builder.