public class HtmlSchemaSerializerBuilder extends HtmlSerializerBuilder
psb| Constructor and Description |
|---|
HtmlSchemaSerializerBuilder()
Constructor, default settings.
|
HtmlSchemaSerializerBuilder(PropertyStore ps)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
HtmlSchemaSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
HtmlSchemaSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
HtmlSchemaSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
HtmlSchemaSerializerBuilder |
addDescriptionsTo(String value)
Configuration property: Add descriptions.
|
HtmlSchemaSerializerBuilder |
addExamplesTo(String value)
Configuration property: Add examples.
|
HtmlSchemaSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
HtmlSchemaSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
HtmlSchemaSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
HtmlSchemaSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
HtmlSchemaSerializerBuilder |
allowNestedDescriptions()
Configuration property: Allow nested descriptions.
|
HtmlSchemaSerializerBuilder |
allowNestedExamples()
Configuration property: Allow nested examples.
|
HtmlSchemaSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
HtmlSchemaSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
HtmlSchemaSerializerBuilder |
applyAnnotations(Class<?> fromClass)
Applies any of the various
|
HtmlSchemaSerializerBuilder |
applyAnnotations(Method fromMethod)
Applies any of the various
|
HtmlSchemaSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
HtmlSchemaSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
HtmlSchemaSerializerBuilder |
beanDefMapper(BeanDefMapper value)
Configuration property: Bean schema definition mapper.
|
HtmlSchemaSerializerBuilder |
beanDefMapper(Class<? extends BeanDefMapper> value)
Configuration property: Schema definition mapper.
|
HtmlSchemaSerializerBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
HtmlSchemaSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
HtmlSchemaSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
HtmlSchemaSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
HtmlSchemaSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
HtmlSchemaSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
HtmlSchemaSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
HtmlSchemaSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
HtmlSchemaSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
HtmlSchemaSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
HtmlSchemaSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
HtmlSchemaSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
HtmlSchemaSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
HtmlSchemaSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
HtmlSchemaSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
HtmlSchemaSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
HtmlSchemaSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
HtmlSchemaSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
HtmlSchemaSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
HtmlSchemaSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
HtmlSchemaSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
HtmlSchemaSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
HtmlSchemaSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
HtmlSchemaSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
HtmlSchemaSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
HtmlSchemaSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
HtmlSchemaSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
HtmlSchemaSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
HtmlSchemaSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
HtmlSchemaSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
HtmlSchemaSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
HtmlSchemaSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
HtmlSchemaSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
HtmlSchemaSerializer |
build()
Build the object.
|
HtmlSchemaSerializerBuilder |
debug()
Configuration property: Debug mode.
|
HtmlSchemaSerializerBuilder |
defaultSchema(Class<?> c,
ObjectMap schema)
Configuration property: Default schemas.
|
HtmlSchemaSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
HtmlSchemaSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
HtmlSchemaSerializerBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
HtmlSchemaSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
HtmlSchemaSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
HtmlSchemaSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
HtmlSchemaSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
HtmlSchemaSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
<T> HtmlSchemaSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> HtmlSchemaSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
HtmlSchemaSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
HtmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
HtmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
HtmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
HtmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
HtmlSchemaSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
HtmlSchemaSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
HtmlSchemaSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
HtmlSchemaSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
HtmlSchemaSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
HtmlSchemaSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
HtmlSchemaSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
HtmlSchemaSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
HtmlSchemaSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
HtmlSchemaSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
HtmlSchemaSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
HtmlSchemaSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
HtmlSchemaSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
HtmlSchemaSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
HtmlSchemaSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
HtmlSchemaSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
HtmlSchemaSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
HtmlSchemaSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
HtmlSchemaSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
HtmlSchemaSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
HtmlSchemaSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
HtmlSchemaSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
HtmlSchemaSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
HtmlSchemaSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
HtmlSchemaSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
HtmlSchemaSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
HtmlSchemaSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
HtmlSchemaSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
HtmlSchemaSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
HtmlSchemaSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
HtmlSchemaSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
HtmlSchemaSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
HtmlSchemaSerializerBuilder |
sq()
Configuration property: Quote character.
|
HtmlSchemaSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
HtmlSchemaSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
HtmlSchemaSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
HtmlSchemaSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
HtmlSchemaSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
HtmlSchemaSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
HtmlSchemaSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
HtmlSchemaSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
HtmlSchemaSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
HtmlSchemaSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
HtmlSchemaSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
HtmlSchemaSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
HtmlSchemaSerializerBuilder |
useBeanDefs()
Configuration property: Use bean definitions.
|
HtmlSchemaSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
HtmlSchemaSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
HtmlSchemaSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
HtmlSchemaSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
HtmlSchemaSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
HtmlSchemaSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
HtmlSchemaSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
HtmlSchemaSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
addKeyValueTableHeaders, addKeyValueTableHeaders, addNamespaceUrisToRoot, addNamespaceUrisToRoot, autoDetectNamespaces, beanFiltersRemove, beanFiltersReplace, beanFiltersReplace, defaultNamespace, detectLabelParameters, detectLinksInStrings, enableNamespaces, labelParameter, namespaces, notBeanClassesRemove, notBeanClassesReplace, notBeanClassesReplace, uriAnchorText, uriAnchorText, xsNamespaceenableNamespaces, namespaces, ns, xsNamespaceuriContext, uriRelativity, uriResolutiondebug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamerbuild, getPropertyStore, getPropertyStoreBuilder, peek, peekpublic HtmlSchemaSerializerBuilder()
public HtmlSchemaSerializerBuilder(PropertyStore ps)
ps - The initial configuration settings for this builder.public HtmlSchemaSerializer build()
ContextBuilderbuild in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder addDescriptionsTo(String value)
Identifies which categories of types that descriptions should be automatically added to generated schemas.
The description is the result of calling ClassMeta.getFullName().
value - The new value for this property.
public HtmlSchemaSerializerBuilder addExamplesTo(String value)
Identifies which categories of types that examples should be automatically added to generated schemas.
The examples come from calling ClassMeta.getExample(BeanSession) which in turn gets examples
from the following:
value - The new value for this property.
public HtmlSchemaSerializerBuilder allowNestedDescriptions()
Identifies whether nested descriptions are allowed in schema definitions.
public HtmlSchemaSerializerBuilder allowNestedExamples()
Identifies whether nested examples are allowed in schema definitions.
public HtmlSchemaSerializerBuilder beanDefMapper(Class<? extends BeanDefMapper> value)
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.JSONSCHEMA_useBeanDefs is not enabled.
value - The new value for this property.
public HtmlSchemaSerializerBuilder beanDefMapper(BeanDefMapper value)
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.JSONSCHEMA_useBeanDefs is not enabled.
value - The new value for this property.
public HtmlSchemaSerializerBuilder defaultSchema(Class<?> c, ObjectMap schema)
Allows you to override or provide custom schema information for particular class types.
Keys are full class names.
c - The class to define a default schema for.schema - The schema.public HtmlSchemaSerializerBuilder useBeanDefs()
When enabled, schemas on beans will be serialized as the following:
{
type:
public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder maxIndent(int value)
WriterSerializerBuilderSpecifies the maximum indentation level in the serialized document.
maxIndent in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder quoteChar(char value)
WriterSerializerBuilderThis is the character used for quoting attributes and values.
quoteChar in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(.
sq in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
useWhitespace in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
ws in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(.
addBeanTypes in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(.
addRootType in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilderSpecifies that recursions should be checked for during traversal.
detectRecursions in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(.
detectRecursions in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(.
ignoreRecursions in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder initialDepth(int value)
BeanTraverseBuilderThe initial indentation level at the root.
initialDepth in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilderClass used to listen for errors and warnings that occur during serialization.
listener in class HtmlSerializerBuildervalue - The new value for this property.public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder sortCollections(boolean value)
SerializerBuilderCopies and sorts the contents of arrays and collections before serializing them.
sortCollections in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(.
sortCollections in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder sortMaps(boolean value)
SerializerBuilderCopies and sorts the contents of maps before serializing them.
sortMaps in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(.
sortMaps in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(.
trimEmptyCollections in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(.
trimEmptyMaps in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim() before being serialized.
trimStrings in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(.
trimStrings in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder uriContext(UriContext value)
SerializerBuilderBean used for resolution of URIs to absolute or root-relative form.
uriContext in class HtmlSerializerBuildervalue - The new value for this property.public HtmlSchemaSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilderDefines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity in class HtmlSerializerBuildervalue - The new value for this property.
UriRelativity.RESOURCEpublic HtmlSchemaSerializerBuilder uriResolution(UriResolution value)
SerializerBuilderDefines the resolution level for URIs when serializing URI/URL objects.
uriResolution in class HtmlSerializerBuildervalue - The new value for this property.
UriResolution.NONEpublic HtmlSchemaSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilderClasses are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility in class HtmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public HtmlSchemaSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilderOnly look for constructors with the specified minimum visibility.
beanConstructorVisibility in class HtmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.@Deprecated public HtmlSchemaSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
beanDictionary in class HtmlSerializerBuildervalues - The values to add to this property.@Deprecated public HtmlSchemaSerializerBuilder beanDictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary in class HtmlSerializerBuildervalues - The values to add to this property.@Deprecated public HtmlSchemaSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class HtmlSerializerBuildervalues - The new values for this property.@Deprecated public HtmlSchemaSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class HtmlSerializerBuildervalues - The new values for this property.@Deprecated public HtmlSchemaSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class HtmlSerializerBuildervalues - The values to remove from this property.@Deprecated public HtmlSchemaSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class HtmlSerializerBuildervalues - The values to remove from this property.public HtmlSchemaSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilderOnly look for bean fields with the specified minimum visibility.
beanFieldVisibility in class HtmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public HtmlSchemaSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but takes in an array of classes.
beanFilters in class HtmlSerializerBuildervalues - The values to add to this property.public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalues - 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 HtmlSchemaSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class HtmlSerializerBuildervalues - 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 HtmlSchemaSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put() method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(.
beanMapPutReturnsOldValue in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilderOnly look for bean methods with the specified minimum visibility.
beanMethodVisibility in class HtmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLICpublic HtmlSchemaSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireDefaultConstructor in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(.
beansRequireDefaultConstructor in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(.
beansRequireSerializable in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(.
beansRequireSettersForGetters in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSomeProperties in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class HtmlSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder bpi(Map<String,String> values)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class HtmlSerializerBuildervalues - The new value for this property.public HtmlSchemaSerializerBuilder bpi(String beanClassName, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class HtmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean class.
bpx in class HtmlSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder bpx(Map<String,String> values)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean classes.
bpx in class HtmlSerializerBuildervalues - The new value for this property.public HtmlSchemaSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilderbpx in class HtmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class HtmlSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder bpro(Map<String,String> values)
BeanContextBuilderSpecifies the read-only properties for the specified bean classes.
bpro in class HtmlSerializerBuildervalues - The new value for this property.public HtmlSchemaSerializerBuilder bpro(String beanClassName, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class HtmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class HtmlSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder bpwo(Map<String,String> values)
BeanContextBuilderSpecifies the write-only properties for the specified bean classes.
bpwo in class HtmlSerializerBuildervalues - The new value for this property.public HtmlSchemaSerializerBuilder bpwo(String beanClassName, String value)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class HtmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public HtmlSchemaSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(.
debug in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
dictionary in class HtmlSerializerBuildervalues - The values to add to this property.public HtmlSchemaSerializerBuilder dictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
dictionary in class HtmlSerializerBuildervalues - The values to add to this property.public HtmlSchemaSerializerBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class HtmlSerializerBuildervalues - The new values for this property.public HtmlSchemaSerializerBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class HtmlSerializerBuildervalues - The new values for this property.public HtmlSchemaSerializerBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class HtmlSerializerBuildervalues - The values to remove from this property.public HtmlSchemaSerializerBuilder dictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class HtmlSerializerBuildervalues - The values to remove from this property.public <T> HtmlSchemaSerializerBuilder example(Class<T> c, T o)
BeanContextBuilderSpecifies an example of the specified class.
example in class HtmlSerializerBuilderc - The POJO class.o - An instance of the POJO class used for examples.public <T> HtmlSchemaSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilderSpecifies an example of the specified class.
exampleJson in class HtmlSerializerBuilderT - The POJO class type.c - The POJO class.value - The simple JSON representation of the example.public HtmlSchemaSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnGetters in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(.
ignoreInvocationExceptionsOnGetters in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnSetters in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(.
ignoreInvocationExceptionsOnSetters in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignorePropertiesWithoutSetters in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownBeanProperties in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(.
ignoreUnknownBeanProperties in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownNullBeanProperties in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilderimplClass in class HtmlSerializerBuilderinterfaceClass - The interface class.implClass - The implementation class.public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalues - The new value for this property.public HtmlSchemaSerializerBuilder locale(Locale value)
BeanContextBuilderSpecifies a default locale for serializer and parser sessions.
locale in class HtmlSerializerBuildervalue - The new value for this property.public HtmlSchemaSerializerBuilder mediaType(MediaType value)
BeanContextBuilderSpecifies a default media type value for serializer and parser sessions.
mediaType in class HtmlSerializerBuildervalue - The new value for this property.public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalues - The values to add to this property.public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalues - The values to add to this property.
public HtmlSchemaSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuildernotBeanClassesRemove in class HtmlSerializerBuildervalues - The values to remove from this property.
public HtmlSchemaSerializerBuilder notBeanPackages(Object... values)
BeanContextBuildernotBeanPackages in class HtmlSerializerBuildervalues - The values to add to this property.
public HtmlSchemaSerializerBuilder notBeanPackages(String... values)
BeanContextBuildernotBeanPackages in class HtmlSerializerBuildervalues - The values to add to this property.public HtmlSchemaSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuildernotBeanPackagesReplace in class HtmlSerializerBuildervalues - public HtmlSchemaSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuildernotBeanPackagesReplace in class HtmlSerializerBuildervalues - public HtmlSchemaSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuildernotBeanPackagesRemove in class HtmlSerializerBuildervalues - The values to remove from this property.public HtmlSchemaSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuildernotBeanPackagesRemove in class HtmlSerializerBuildervalues - public HtmlSchemaSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilderpojoSwaps in class HtmlSerializerBuildervalues - The values to add to this property.public HtmlSchemaSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilderpojoSwaps in class HtmlSerializerBuildervalues - The values to add to this property.
PojoSwap.
SurrogateSwap.
public HtmlSchemaSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilderpojoSwapsReplace in class HtmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlSchemaSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilderpojoSwapsReplace in class HtmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlSchemaSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilderpojoSwapsRemove in class HtmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlSchemaSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilderpojoSwapsRemove in class HtmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public HtmlSchemaSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(.
sortProperties in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder timeZone(TimeZone value)
BeanContextBuildertimeZone in class HtmlSerializerBuildervalue - The new value for this property.public HtmlSchemaSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class HtmlSerializerBuildervalue - The property value.public HtmlSchemaSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler if there is no other way of instantiating them.
useInterfaceProxies in class HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuildervalue - The new value for this property.
public HtmlSchemaSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(.
useJavaBeanIntrospector in class HtmlSerializerBuilderpublic HtmlSchemaSerializerBuilder set(String name, Object value)
ContextBuilderset in class HtmlSerializerBuildername - The property name.value - The property value.PropertyStoreBuilder.set(String, Object)public HtmlSchemaSerializerBuilder set(Map<String,Object> properties)
ContextBuilderset in class HtmlSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)public HtmlSchemaSerializerBuilder add(Map<String,Object> properties)
ContextBuilderadd in class HtmlSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)public HtmlSchemaSerializerBuilder addTo(String name, Object value)
ContextBuilderaddTo in class HtmlSerializerBuildername - The property name.value - The new value to add to the SET property.public HtmlSchemaSerializerBuilder addTo(String name, String key, Object value)
ContextBuilderaddTo in class HtmlSerializerBuildername - The property name.key - The property value map key.value - The property value map value.public HtmlSchemaSerializerBuilder removeFrom(String name, Object value)
ContextBuilderremoveFrom in class HtmlSerializerBuildername - The property name.value - The property value in the SET property.public HtmlSchemaSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilderapply in class HtmlSerializerBuildercopyFrom - The factory whose settings are being copied.public HtmlSchemaSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilderapplyAnnotations in class HtmlSerializerBuilderal - The list of all annotations annotated with PropertyStoreApply.vrs - The string resolver for resolving variables in annotation values.public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuilderfromClass - The class on which the annotations are defined.public HtmlSchemaSerializerBuilder 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 HtmlSerializerBuilderfromMethod - The method on which the annotations are defined.Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.