public class HtmlDocSerializerBuilder extends HtmlStrippedDocSerializerBuilder
psb| Constructor and Description |
|---|
HtmlDocSerializerBuilder()
Constructor, default settings.
|
HtmlDocSerializerBuilder(PropertyStore ps)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
HtmlDocSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
HtmlDocSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
HtmlDocSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
HtmlDocSerializerBuilder |
addKeyValueTableHeaders()
Configuration property: Add key/value headers on bean/map tables.
|
HtmlDocSerializerBuilder |
addKeyValueTableHeaders(boolean value)
Configuration property: Add key/value headers on bean/map tables.
|
HtmlDocSerializerBuilder |
addNamespaceUrisToRoot()
Configuration property: Add namespace URLs to the root element.
|
HtmlDocSerializerBuilder |
addNamespaceUrisToRoot(boolean value)
Configuration property: Add namespace URLs to the root element.
|
HtmlDocSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
HtmlDocSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
HtmlDocSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
HtmlDocSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
HtmlDocSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
HtmlDocSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
HtmlDocSerializerBuilder |
applyAnnotations(Class<?> fromClass)
Applies any of the various
|
HtmlDocSerializerBuilder |
applyAnnotations(Method fromMethod)
Applies any of the various
|
HtmlDocSerializerBuilder |
aside(String[] value)
Configuration property: Aside section contents.
|
HtmlDocSerializerBuilder |
autoDetectNamespaces(boolean value)
Configuration property: Auto-detect namespace usage.
|
HtmlDocSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
HtmlDocSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
HtmlDocSerializerBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
HtmlDocSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
HtmlDocSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
HtmlDocSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
HtmlDocSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
HtmlDocSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
HtmlDocSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
HtmlDocSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
HtmlDocSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
HtmlDocSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
HtmlDocSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
HtmlDocSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
HtmlDocSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
HtmlDocSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
HtmlDocSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
HtmlDocSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
HtmlDocSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
HtmlDocSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
HtmlDocSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
HtmlDocSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
HtmlDocSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
HtmlDocSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
HtmlDocSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
HtmlDocSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
HtmlDocSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
HtmlDocSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
HtmlDocSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
HtmlDocSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
HtmlDocSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
HtmlDocSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
HtmlDocSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
HtmlDocSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
HtmlDocSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
HtmlDocSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
HtmlDocSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
HtmlDocSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
HtmlDocSerializer |
build()
Build the object.
|
HtmlDocSerializerBuilder |
debug()
Configuration property: Debug mode.
|
HtmlDocSerializerBuilder |
defaultNamespace(String value)
Configuration property: Default namespace.
|
HtmlDocSerializerBuilder |
detectLabelParameters(boolean value)
Configuration property: Look for link labels in URIs.
|
HtmlDocSerializerBuilder |
detectLinksInStrings(boolean value)
Configuration property: Look for URLs in
Strings. |
HtmlDocSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
HtmlDocSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
HtmlDocSerializerBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
HtmlDocSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
HtmlDocSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
HtmlDocSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
HtmlDocSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
HtmlDocSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
HtmlDocSerializerBuilder |
enableNamespaces(boolean value)
Configuration property: Enable support for XML namespaces.
|
<T> HtmlDocSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> HtmlDocSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
HtmlDocSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
HtmlDocSerializerBuilder |
footer(String[] value)
Configuration property: Footer section contents.
|
HtmlDocSerializerBuilder |
head(String[] value)
Configuration property: Additional head section content.
|
HtmlDocSerializerBuilder |
header(String[] value)
Configuration property: Header section contents.
|
HtmlDocSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
HtmlDocSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
HtmlDocSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
HtmlDocSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
HtmlDocSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
HtmlDocSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
HtmlDocSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
HtmlDocSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
HtmlDocSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
HtmlDocSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
HtmlDocSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
HtmlDocSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
HtmlDocSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
HtmlDocSerializerBuilder |
labelParameter(String value)
Configuration property: Link label parameter name.
|
HtmlDocSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
HtmlDocSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
HtmlDocSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
HtmlDocSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
HtmlDocSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
HtmlDocSerializerBuilder |
namespaces(Namespace... values)
Configuration property: Default namespaces.
|
HtmlDocSerializerBuilder |
nav(String[] value)
Configuration property: Nav section contents.
|
HtmlDocSerializerBuilder |
navlinks_replace(String[] value)
Configuration property: Page navigation links.
|
HtmlDocSerializerBuilder |
navlinks(String[] value)
Configuration property: Add to the
HtmlDocSerializer.HTMLDOC_navlinks property. |
HtmlDocSerializerBuilder |
noResultsMessage(String value)
Configuration property: No-results message.
|
HtmlDocSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
HtmlDocSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
HtmlDocSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
HtmlDocSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
HtmlDocSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
HtmlDocSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
HtmlDocSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
HtmlDocSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
HtmlDocSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
HtmlDocSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
HtmlDocSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
HtmlDocSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
HtmlDocSerializerBuilder |
nowrap(boolean value)
Configuration property: Prevent word wrap on page.
|
HtmlDocSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
HtmlDocSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
HtmlDocSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
HtmlDocSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
HtmlDocSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
HtmlDocSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
HtmlDocSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
HtmlDocSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
HtmlDocSerializerBuilder |
script_replace(String[] value)
Configuration property: Javascript code.
|
HtmlDocSerializerBuilder |
script(String[] value)
Configuration property: Add to the
HtmlDocSerializer.HTMLDOC_script property. |
HtmlDocSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
HtmlDocSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
HtmlDocSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
HtmlDocSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
HtmlDocSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
HtmlDocSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
HtmlDocSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
HtmlDocSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
HtmlDocSerializerBuilder |
sq()
Configuration property: Quote character.
|
HtmlDocSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
HtmlDocSerializerBuilder |
style_replace(String[] value)
Configuration property: CSS style code.
|
HtmlDocSerializerBuilder |
style(String[] value)
Configuration property: Add to the
HtmlDocSerializer.HTMLDOC_style property. |
HtmlDocSerializerBuilder |
stylesheet_replace(String[] value)
Configuration property: Stylesheet import URLs.
|
HtmlDocSerializerBuilder |
stylesheet(String[] value)
Configuration property: Add to the
HtmlDocSerializer.HTMLDOC_stylesheet property. |
HtmlDocSerializerBuilder |
template(Class<?> value)
Configuration property: HTML document template.
|
HtmlDocSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
HtmlDocSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
HtmlDocSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
HtmlDocSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
HtmlDocSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
HtmlDocSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
HtmlDocSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
HtmlDocSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
HtmlDocSerializerBuilder |
uriAnchorText(AnchorText value)
Configuration property: Anchor text source.
|
HtmlDocSerializerBuilder |
uriAnchorText(String value)
Configuration property: Anchor text source.
|
HtmlDocSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
HtmlDocSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
HtmlDocSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
HtmlDocSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
HtmlDocSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
HtmlDocSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
HtmlDocSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
HtmlDocSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
HtmlDocSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
HtmlDocSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
HtmlDocSerializerBuilder |
widgets(Class<? extends HtmlWidget>... values)
Configuration property: HTML Widgets.
|
HtmlDocSerializerBuilder |
widgets(HtmlWidget... values)
Configuration property: HTML Widgets.
|
HtmlDocSerializerBuilder |
widgetsReplace(Class<? extends HtmlWidget>... values)
Configuration property: HTML Widgets.
|
HtmlDocSerializerBuilder |
widgetsReplace(HtmlWidget... values)
Configuration property: HTML Widgets.
|
HtmlDocSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
HtmlDocSerializerBuilder |
xsNamespace(Namespace value)
Configuration property: XMLSchema namespace.
|
enableNamespaces, namespaces, ns, xsNamespaceuriContext, uriRelativity, uriResolutiondebug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamerbuild, getPropertyStore, getPropertyStoreBuilder, peek, peekpublic HtmlDocSerializerBuilder()
public HtmlDocSerializerBuilder(PropertyStore ps)
ps - The initial configuration settings for this builder.public HtmlDocSerializer build()
ContextBuilderbuild in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder aside(String[] value)
Allows you to specify the contents of the aside section on the HTML page. The aside section floats on the right of the page for providing content supporting the serialized content of the page.
By default, the aside section is empty.
value - The new value for this property.public HtmlDocSerializerBuilder footer(String[] value)
Allows you to specify the contents of the footer section on the HTML page.
By default, the footer section is empty.
value - The new value for this property.public HtmlDocSerializerBuilder head(String[] value)
Adds the specified HTML content to the head section of the page.
value - The new value for this property.public HtmlDocSerializerBuilder header(String[] value)
Allows you to override the contents of the header section on the HTML page. The header section normally contains the title and description at the top of the page.
value - The new value for this property.public HtmlDocSerializerBuilder nav(String[] value)
Allows you to override the contents of the nav section on the HTML page. The nav section normally contains the page links at the top of the page.
When this property is specified, the HtmlDocSerializer.HTMLDOC_navlinks property is ignored.
value - The new value for this property.public HtmlDocSerializerBuilder navlinks_replace(String[] value)
Adds a list of hyperlinks immediately under the title and description but above the content of the page.
This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.
The value is an array of strings with two possible values:
Relative URLs are considered relative to the servlet path.
For example, if the servlet path is UriResolver such as
value - The new value for this property.public HtmlDocSerializerBuilder navlinks(String[] value)
HtmlDocSerializer.HTMLDOC_navlinks property.value - The value to add to this property.public HtmlDocSerializerBuilder noResultsMessage(String value)
Allows you to specify the string message used when trying to serialize an empty array or empty list.
A value of
value - The new value for this property.public HtmlDocSerializerBuilder nowrap(boolean value)
Adds
value - The new value for this property.public HtmlDocSerializerBuilder script_replace(String[] value)
Adds the specified Javascript code to the HTML page.
value - The new value for this property.public HtmlDocSerializerBuilder script(String[] value)
HtmlDocSerializer.HTMLDOC_script property.value - The value to add to this property.public HtmlDocSerializerBuilder style_replace(String[] value)
Adds the specified CSS instructions to the HTML page.
value - The new value for this property.public HtmlDocSerializerBuilder style(String[] value)
HtmlDocSerializer.HTMLDOC_style property.value - The value to add to this property.public HtmlDocSerializerBuilder stylesheet_replace(String[] value)
Adds a link to the specified stylesheet URL.
Note that this stylesheet is controlled by the annotation.
value - The new value for this property.public HtmlDocSerializerBuilder stylesheet(String[] value)
HtmlDocSerializer.HTMLDOC_stylesheet property.value - The value to add to this property.public HtmlDocSerializerBuilder template(Class<?> value)
Specifies the template to use for serializing the page.
By default, the BasicHtmlDocTemplate class is used to construct the contents of the HTML page, but
can be overridden with your own custom implementation class.
value - The new value for this property.public HtmlDocSerializerBuilder widgets(Class<? extends HtmlWidget>... values)
Defines widgets that can be used in conjunction with string variables of the form
values - The values to add to this setting.public HtmlDocSerializerBuilder widgetsReplace(Class<? extends HtmlWidget>... values)
Same as widgets(Class...) but replaces any previous values.
values - The values to set on this setting.public HtmlDocSerializerBuilder widgets(HtmlWidget... values)
Same as widgets(Class...) except input is pre-constructed instances.
values - The values to add to this setting.public HtmlDocSerializerBuilder widgetsReplace(HtmlWidget... values)
Same as widgets(HtmlWidget...) except allows you to overwrite the previous value.
values - The values to add to this setting.public HtmlDocSerializerBuilder addKeyValueTableHeaders(boolean value)
HtmlSerializerBuilderaddKeyValueTableHeaders in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder addKeyValueTableHeaders()
HtmlSerializerBuilder
Shortcut for calling addKeyValueTableHeaders(.
addKeyValueTableHeaders in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder detectLinksInStrings(boolean value)
HtmlSerializerBuilderStrings.
If a string looks like a URL (e.g. starts with HtmlSerializer.HTML_uriAnchorText.
detectLinksInStrings in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder labelParameter(String value)
HtmlSerializerBuilder
The parameter name to look for when resolving link labels via HtmlSerializer.HTML_detectLabelParameters.
labelParameter in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder detectLabelParameters(boolean value)
HtmlSerializerBuilder
If the URL has a label parameter (e.g.
detectLabelParameters in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder uriAnchorText(AnchorText value)
HtmlSerializerBuilder
When creating anchor tags (e.g. )
in HTML, this setting defines what to set the inner text to.
uriAnchorText in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
AnchorText.TO_STRING.public HtmlDocSerializerBuilder uriAnchorText(String value)
HtmlSerializerBuilder
Same as HtmlSerializerBuilder.uriAnchorText(AnchorText) but takes in a string.
uriAnchorText in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
AnchorText.TO_STRING.public HtmlDocSerializerBuilder addNamespaceUrisToRoot(boolean value)
XmlSerializerBuilder
Use this setting to add xmlns:x attributes to the root element for the default and all mapped namespaces.
addNamespaceUrisToRoot in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder addNamespaceUrisToRoot()
XmlSerializerBuilder
Shortcut for calling addNamespaceUrisToRoot(.
addNamespaceUrisToRoot in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder autoDetectNamespaces(boolean value)
XmlSerializerBuilderDetect namespace usage before serialization.
autoDetectNamespaces in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder defaultNamespace(String value)
XmlSerializerBuilderSpecifies the default namespace URI for this document.
defaultNamespace in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder enableNamespaces(boolean value)
XmlSerializerBuilderIf not enabled, XML output will not contain any namespaces regardless of any other settings.
enableNamespaces in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder namespaces(Namespace... values)
XmlSerializerBuilderThe default list of namespaces associated with this serializer.
namespaces in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.public HtmlDocSerializerBuilder xsNamespace(Namespace value)
XmlSerializerBuilder
Specifies the namespace for the XmlSchemaSerializer class.
xsNamespace in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder fileCharset(Charset value)
WriterSerializerBuilderThe character set to use for writing Files to the file system.
Used when passing in files to Serializer.serialize(Object, Object).
fileCharset in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder maxIndent(int value)
WriterSerializerBuilderSpecifies the maximum indentation level in the serialized document.
maxIndent in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder quoteChar(char value)
WriterSerializerBuilderThis is the character used for quoting attributes and values.
quoteChar in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(.
sq in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder streamCharset(Charset value)
WriterSerializerBuilderThe character set to use when writing to OutputStreams.
Used when passing in output streams and byte arrays to Serializer.serialize(Object, Object).
streamCharset in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
useWhitespace in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
ws in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(.
addBeanTypes in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder addRootType(boolean value)
SerializerBuilderWhen disabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level type information that might normally be included to determine the data type will not be serialized.
addRootType in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(.
addRootType in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilderSpecifies that recursions should be checked for during traversal.
detectRecursions in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(.
detectRecursions in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(.
ignoreRecursions in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder initialDepth(int value)
BeanTraverseBuilderThe initial indentation level at the root.
initialDepth in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilderClass used to listen for errors and warnings that occur during serialization.
listener in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.public HtmlDocSerializerBuilder maxDepth(int value)
BeanTraverseBuilder
Abort traversal if specified depth is reached in the POJO tree.
If this depth is exceeded, an exception is thrown.
This prevents stack overflows from occurring when trying to traverse models with recursive references.
maxDepth in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder sortCollections(boolean value)
SerializerBuilderCopies and sorts the contents of arrays and collections before serializing them.
sortCollections in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(.
sortCollections in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder sortMaps(boolean value)
SerializerBuilderCopies and sorts the contents of maps before serializing them.
sortMaps in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(.
sortMaps in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(.
trimEmptyCollections in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(.
trimEmptyMaps in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim() before being serialized.
trimStrings in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(.
trimStrings in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder uriContext(UriContext value)
SerializerBuilderBean used for resolution of URIs to absolute or root-relative form.
uriContext in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.public HtmlDocSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilderDefines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
UriRelativity.RESOURCEpublic HtmlDocSerializerBuilder uriResolution(UriResolution value)
SerializerBuilderDefines the resolution level for URIs when serializing URI/URL objects.
uriResolution in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
UriResolution.NONEpublic HtmlDocSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilderClasses are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public HtmlDocSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilderOnly look for constructors with the specified minimum visibility.
beanConstructorVisibility in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.@Deprecated public HtmlDocSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
beanDictionary in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.@Deprecated public HtmlDocSerializerBuilder beanDictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.@Deprecated public HtmlDocSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class HtmlStrippedDocSerializerBuildervalues - The new values for this property.@Deprecated public HtmlDocSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class HtmlStrippedDocSerializerBuildervalues - The new values for this property.@Deprecated public HtmlDocSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.@Deprecated public HtmlDocSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.public HtmlDocSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilderOnly look for bean fields with the specified minimum visibility.
beanFieldVisibility in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public HtmlDocSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but takes in an array of classes.
beanFilters in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.public HtmlDocSerializerBuilder beanFilters(Object... values)
BeanContextBuilder
This is a programmatic equivalent to the @Bean annotation.
It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter
the bean classes.
beanFilters in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public HtmlDocSerializerBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class HtmlStrippedDocSerializerBuildervalues - The new values for this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public HtmlDocSerializerBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class HtmlStrippedDocSerializerBuildervalues - The new values for this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public HtmlDocSerializerBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public HtmlDocSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public HtmlDocSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put() method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(.
beanMapPutReturnsOldValue in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilderOnly look for bean methods with the specified minimum visibility.
beanMethodVisibility in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
Visibility.PUBLICpublic HtmlDocSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireDefaultConstructor in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(.
beansRequireDefaultConstructor in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder beansRequireSerializable(boolean value)
BeanContextBuilder
If Serializable interface to be considered a bean.
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSerializable in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(.
beansRequireSerializable in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(.
beansRequireSettersForGetters in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSomeProperties in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder beanTypePropertyName(String value)
BeanContextBuilderThis specifies the name of the bean property used to store the dictionary name of a bean type so that the parser knows the data type to reconstruct.
beanTypePropertyName in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class HtmlStrippedDocSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public HtmlDocSerializerBuilder bpi(Map<String,String> values)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.public HtmlDocSerializerBuilder bpi(String beanClassName, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class HtmlStrippedDocSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlDocSerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean class.
bpx in class HtmlStrippedDocSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public HtmlDocSerializerBuilder bpx(Map<String,String> values)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean classes.
bpx in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.public HtmlDocSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilderbpx in class HtmlStrippedDocSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlDocSerializerBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class HtmlStrippedDocSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public HtmlDocSerializerBuilder bpro(Map<String,String> values)
BeanContextBuilderSpecifies the read-only properties for the specified bean classes.
bpro in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.public HtmlDocSerializerBuilder bpro(String beanClassName, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class HtmlStrippedDocSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlDocSerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class HtmlStrippedDocSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public HtmlDocSerializerBuilder bpwo(Map<String,String> values)
BeanContextBuilderSpecifies the write-only properties for the specified bean classes.
bpwo in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.public HtmlDocSerializerBuilder bpwo(String beanClassName, String value)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class HtmlStrippedDocSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlDocSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(.
debug in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
dictionary in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.public HtmlDocSerializerBuilder dictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
dictionary in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.public HtmlDocSerializerBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class HtmlStrippedDocSerializerBuildervalues - The new values for this property.public HtmlDocSerializerBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class HtmlStrippedDocSerializerBuildervalues - The new values for this property.public HtmlDocSerializerBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.public HtmlDocSerializerBuilder dictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.public <T> HtmlDocSerializerBuilder example(Class<T> c, T o)
BeanContextBuilderSpecifies an example of the specified class.
example in class HtmlStrippedDocSerializerBuilderc - The POJO class.o - An instance of the POJO class used for examples.public <T> HtmlDocSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilderSpecifies an example of the specified class.
exampleJson in class HtmlStrippedDocSerializerBuilderT - The POJO class type.c - The POJO class.value - The simple JSON representation of the example.public HtmlDocSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnGetters in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(.
ignoreInvocationExceptionsOnGetters in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnSetters in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(.
ignoreInvocationExceptionsOnSetters in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignorePropertiesWithoutSetters in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownBeanProperties in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(.
ignoreUnknownBeanProperties in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownNullBeanProperties in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilderimplClass in class HtmlStrippedDocSerializerBuilderinterfaceClass - The interface class.implClass - The implementation class.public HtmlDocSerializerBuilder implClasses(Map<String,Class<?>> values)
BeanContextBuilderFor interfaces and abstract classes this method can be used to specify an implementation class for the interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a parse).
implClasses in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.public HtmlDocSerializerBuilder locale(Locale value)
BeanContextBuilderSpecifies a default locale for serializer and parser sessions.
locale in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.public HtmlDocSerializerBuilder mediaType(MediaType value)
BeanContextBuilderSpecifies a default media type value for serializer and parser sessions.
mediaType in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.public HtmlDocSerializerBuilder notBeanClasses(Class<?>... values)
BeanContextBuilder
List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to
notBeanClasses in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.public HtmlDocSerializerBuilder notBeanClasses(Object... values)
BeanContextBuilder
List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to
notBeanClasses in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.
public HtmlDocSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.public HtmlDocSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class HtmlStrippedDocSerializerBuildervalues - The new value for this property.
public HtmlDocSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuildernotBeanClassesRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.public HtmlDocSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuildernotBeanClassesRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.
public HtmlDocSerializerBuilder notBeanPackages(Object... values)
BeanContextBuildernotBeanPackages in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.
public HtmlDocSerializerBuilder notBeanPackages(String... values)
BeanContextBuildernotBeanPackages in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.public HtmlDocSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuildernotBeanPackagesReplace in class HtmlStrippedDocSerializerBuildervalues - public HtmlDocSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuildernotBeanPackagesReplace in class HtmlStrippedDocSerializerBuildervalues - public HtmlDocSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuildernotBeanPackagesRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.public HtmlDocSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuildernotBeanPackagesRemove in class HtmlStrippedDocSerializerBuildervalues - public HtmlDocSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilderpojoSwaps in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.public HtmlDocSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilderpojoSwaps in class HtmlStrippedDocSerializerBuildervalues - The values to add to this property.
PojoSwap.
SurrogateSwap.
public HtmlDocSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilderpojoSwapsReplace in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlDocSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilderpojoSwapsReplace in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlDocSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilderpojoSwapsRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlDocSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilderpojoSwapsRemove in class HtmlStrippedDocSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlDocSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(.
sortProperties in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder timeZone(TimeZone value)
BeanContextBuildertimeZone in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.public HtmlDocSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class HtmlStrippedDocSerializerBuildervalue - The property value.public HtmlDocSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler if there is no other way of instantiating them.
useInterfaceProxies in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder useJavaBeanIntrospector(boolean value)
BeanContextBuilderUsing the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
@Bean annotations will be ignored if you enable this setting.
useJavaBeanIntrospector in class HtmlStrippedDocSerializerBuildervalue - The new value for this property.
public HtmlDocSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(.
useJavaBeanIntrospector in class HtmlStrippedDocSerializerBuilderpublic HtmlDocSerializerBuilder set(String name, Object value)
ContextBuilderset in class HtmlStrippedDocSerializerBuildername - The property name.value - The property value.PropertyStoreBuilder.set(String, Object)public HtmlDocSerializerBuilder set(Map<String,Object> properties)
ContextBuilderset in class HtmlStrippedDocSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)public HtmlDocSerializerBuilder add(Map<String,Object> properties)
ContextBuilderadd in class HtmlStrippedDocSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)public HtmlDocSerializerBuilder addTo(String name, Object value)
ContextBuilderaddTo in class HtmlStrippedDocSerializerBuildername - The property name.value - The new value to add to the SET property.public HtmlDocSerializerBuilder addTo(String name, String key, Object value)
ContextBuilderaddTo in class HtmlStrippedDocSerializerBuildername - The property name.key - The property value map key.value - The property value map value.public HtmlDocSerializerBuilder removeFrom(String name, Object value)
ContextBuilderremoveFrom in class HtmlStrippedDocSerializerBuildername - The property name.value - The property value in the SET property.public HtmlDocSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilderapply in class HtmlStrippedDocSerializerBuildercopyFrom - The factory whose settings are being copied.public HtmlDocSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilderapplyAnnotations in class HtmlStrippedDocSerializerBuilderal - The list of all annotations annotated with PropertyStoreApply.vrs - The string resolver for resolving variables in annotation values.public HtmlDocSerializerBuilder applyAnnotations(Class<?> fromClass)
ContextBuilderApplies any of the following annotations:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations are appended in the following order:
applyAnnotations in class HtmlStrippedDocSerializerBuilderfromClass - The class on which the annotations are defined.public HtmlDocSerializerBuilder applyAnnotations(Method fromMethod)
ContextBuilderApplies any of the following annotations:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations are appended in the following orders:
applyAnnotations in class HtmlStrippedDocSerializerBuilderfromMethod - The method on which the annotations are defined.Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.