public class XmlSchemaSerializerBuilder extends XmlSerializerBuilder
psb
Constructor and Description |
---|
XmlSchemaSerializerBuilder()
Constructor, default settings.
|
XmlSchemaSerializerBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
XmlSchemaSerializerBuilder |
abridged()
Configuration property: Abridged output.
|
XmlSchemaSerializerBuilder |
abridged(boolean value)
Configuration property: Abridged output.
|
XmlSchemaSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
XmlSchemaSerializerBuilder |
addBeanTypeProperties(boolean value)
Configuration property: Add
|
XmlSchemaSerializerBuilder |
addNamespaceUrisToRoot()
Configuration property: Add namespace URLs to the root element.
|
XmlSchemaSerializerBuilder |
addNamespaceUrisToRoot(boolean value)
Configuration property: Add namespace URLs to the root element.
|
XmlSchemaSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
XmlSchemaSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
XmlSchemaSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
XmlSchemaSerializerBuilder |
autoDetectNamespaces(boolean value)
Configuration property: Auto-detect namespace usage.
|
XmlSchemaSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
XmlSchemaSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
XmlSchemaSerializerBuilder |
beanDictionary(boolean append,
Object... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
beanDictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
beanDictionary(Object... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
beanDictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
XmlSchemaSerializerBuilder |
beanFilters(boolean append,
Object... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
XmlSchemaSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
XmlSchemaSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
XmlSchemaSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
XmlSchemaSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
XmlSchemaSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
XmlSchemaSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
XmlSchemaSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
XmlSchemaSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
XmlSchemaSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
XmlSchemaSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
XmlSchemaSerializer |
build()
Build the object.
|
XmlSchemaSerializerBuilder |
debug()
Configuration property: Debug mode.
|
XmlSchemaSerializerBuilder |
defaultNamespace(String value)
Configuration property: Default namespace.
|
XmlSchemaSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
XmlSchemaSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
XmlSchemaSerializerBuilder |
enableNamespaces(boolean value)
Configuration property: Enable support for XML namespaces.
|
XmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
XmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
XmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
XmlSchemaSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
XmlSchemaSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
XmlSchemaSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
XmlSchemaSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
XmlSchemaSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
XmlSchemaSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
XmlSchemaSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
<T> XmlSchemaSerializerBuilder |
implClass(Class<T> interfaceClass,
Class<? extends T> implClass)
Configuration property: Implementation classes.
|
XmlSchemaSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
XmlSchemaSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
XmlSchemaSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
XmlSchemaSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
XmlSchemaSerializerBuilder |
maxDepth(int value)
Configuration property: Max serialization depth.
|
XmlSchemaSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
XmlSchemaSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
XmlSchemaSerializerBuilder |
namespaces(Namespace... values)
Configuration property: Default namespaces.
|
XmlSchemaSerializerBuilder |
notBeanClasses(boolean append,
Object... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanPackages(boolean append,
Object... values)
Configuration property: Bean package exclusions.
|
XmlSchemaSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
XmlSchemaSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
XmlSchemaSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
XmlSchemaSerializerBuilder |
pojoSwaps(boolean append,
Object... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
XmlSchemaSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
XmlSchemaSerializerBuilder |
set(boolean append,
String name,
Object value)
Sets or adds to a SET or LIST property.
|
XmlSchemaSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
XmlSchemaSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
XmlSchemaSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
XmlSchemaSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
XmlSchemaSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
XmlSchemaSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
XmlSchemaSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
XmlSchemaSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
XmlSchemaSerializerBuilder |
sq()
Configuration property: Quote character.
|
XmlSchemaSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
XmlSchemaSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
XmlSchemaSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
XmlSchemaSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
XmlSchemaSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
XmlSchemaSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
XmlSchemaSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
XmlSchemaSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
XmlSchemaSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
XmlSchemaSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
XmlSchemaSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
XmlSchemaSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
XmlSchemaSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
XmlSchemaSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
XmlSchemaSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
XmlSchemaSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
XmlSchemaSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
XmlSchemaSerializerBuilder |
xsNamespace(Namespace value)
Configuration property: XMLSchema namespace.
|
enableNamespaces, ns
uriContext, uriRelativity, uriResolution
debug, excludeProperties, excludeProperties, excludeProperties, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder
public XmlSchemaSerializerBuilder()
public XmlSchemaSerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public XmlSchemaSerializer build()
ContextBuilder
build
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder 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 XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder addNamespaceUrisToRoot()
XmlSerializerBuilder
Shortcut for calling addNamespaceUrisToRoot(
.
addNamespaceUrisToRoot
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder autoDetectNamespaces(boolean value)
XmlSerializerBuilder
Detect namespace usage before serialization.
autoDetectNamespaces
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder defaultNamespace(String value)
XmlSerializerBuilder
Specifies the default namespace URI for this document.
defaultNamespace
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder enableNamespaces(boolean value)
XmlSerializerBuilder
If not enabled, XML output will not contain any namespaces regardless of any other settings.
enableNamespaces
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder namespaces(Namespace... values)
XmlSerializerBuilder
The default list of namespaces associated with this serializer.
namespaces
in class XmlSerializerBuilder
values
- The new value for this property.public XmlSchemaSerializerBuilder xsNamespace(Namespace value)
XmlSerializerBuilder
Specifies the namespace for the XMLSchema
namespace, used by the schema generated by the
XmlSchemaSerializer
class.
xsNamespace
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder abridged(boolean value)
SerializerBuilder
When enabled, 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.
abridged
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder abridged()
SerializerBuilder
Shortcut for calling abridged(
.
abridged
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder addBeanTypeProperties(boolean value)
SerializerBuilder
If
addBeanTypeProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder detectRecursions(boolean value)
SerializerBuilder
Specifies that recursions should be checked for during serialization.
detectRecursions
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder detectRecursions()
SerializerBuilder
Shortcut for calling detectRecursions(
.
detectRecursions
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder ignoreRecursions(boolean value)
SerializerBuilder
If
ignoreRecursions
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder ignoreRecursions()
SerializerBuilder
Shortcut for calling ignoreRecursions(
.
ignoreRecursions
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder initialDepth(int value)
SerializerBuilder
The initial indentation level at the root.
initialDepth
in class XmlSerializerBuilder
value
- The new value for this property.
0
.public XmlSchemaSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilder
Class used to listen for errors and warnings that occur during serialization.
listener
in class XmlSerializerBuilder
value
- The new value for this property.public XmlSchemaSerializerBuilder maxDepth(int value)
SerializerBuilder
Abort serialization 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 serialize models with recursive references.
maxDepth
in class XmlSerializerBuilder
value
- The new value for this property.
100
.public XmlSchemaSerializerBuilder maxIndent(int value)
SerializerBuilder
Specifies the maximum indentation level in the serialized document.
maxIndent
in class XmlSerializerBuilder
value
- The new value for this property.
100
.public XmlSchemaSerializerBuilder quoteChar(char value)
SerializerBuilder
This is the character used for quoting attributes and values.
quoteChar
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder sortCollections(boolean value)
SerializerBuilder
Copies and sorts the contents of arrays and collections before serializing them.
sortCollections
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(
.
sortCollections
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder sortMaps(boolean value)
SerializerBuilder
Copies and sorts the contents of maps before serializing them.
sortMaps
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(
.
sortMaps
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder sq()
SerializerBuilder
Shortcut for calling quoteChar(
.
sq
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(
.
trimEmptyCollections
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(
.
trimEmptyMaps
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim()
before being serialized.
trimStrings
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(
.
trimStrings
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder uriContext(UriContext value)
SerializerBuilder
Bean used for resolution of URIs to absolute or root-relative form.
uriContext
in class XmlSerializerBuilder
value
- The new value for this property.public XmlSchemaSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilder
Defines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity
in class XmlSerializerBuilder
value
- The new value for this property.
UriRelativity.RESOURCE
public XmlSchemaSerializerBuilder uriResolution(UriResolution value)
SerializerBuilder
Defines the resolution level for URIs when serializing URI/URL objects.
uriResolution
in class XmlSerializerBuilder
value
- The new value for this property.
UriResolution.NONE
public XmlSchemaSerializerBuilder useWhitespace(boolean value)
SerializerBuilder
If
useWhitespace
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder useWhitespace()
SerializerBuilder
Shortcut for calling useWhitespace(
.
useWhitespace
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder ws()
SerializerBuilder
Shortcut for calling useWhitespace(
.
ws
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireDefaultConstructor
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder 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 XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSomeProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put()
method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
beanConstructorVisibility
in class XmlSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public XmlSchemaSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilder
Classes are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is PUBLIC
and the bean class is
beanClassVisibility
in class XmlSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public XmlSchemaSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
beanFieldVisibility
in class XmlSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public XmlSchemaSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
beanMethodVisibility
in class XmlSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
public XmlSchemaSerializerBuilder useJavaBeanIntrospector(boolean value)
BeanContextBuilder
Using 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 XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler
if there is no other way of instantiating them.
useInterfaceProxies
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class XmlSerializerBuilder
values
- The values to add to this property.
public XmlSchemaSerializerBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class XmlSerializerBuilder
values
- The values to add to this property.public XmlSchemaSerializerBuilder notBeanPackages(boolean append, Object... values)
BeanContextBuilder
When specified, the current list of ignore packages are appended to.
notBeanPackages
in class XmlSerializerBuilder
append
- If values
- The new values for this property.
public XmlSchemaSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class XmlSerializerBuilder
values
- public XmlSchemaSerializerBuilder 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 Strings
during serialization.
notBeanClasses
in class XmlSerializerBuilder
values
- The values to add to this property.
public XmlSchemaSerializerBuilder 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 Strings
during serialization.
notBeanClasses
in class XmlSerializerBuilder
values
- The values to add to this property.public XmlSchemaSerializerBuilder notBeanClasses(boolean append, Object... values)
BeanContextBuilder
Not-bean classes are converted to Strings
during serialization even if they appear to be
bean-like.
notBeanClasses
in class XmlSerializerBuilder
append
- If values
- The new value for this property.
public XmlSchemaSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.
public XmlSchemaSerializerBuilder 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 XmlSerializerBuilder
values
- 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 XmlSchemaSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but takes in an array of classes.
beanFilters
in class XmlSerializerBuilder
values
- The values to add to this property.public XmlSchemaSerializerBuilder beanFilters(boolean append, Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but allows you to optionally overwrite the previous value.
beanFilters
in class XmlSerializerBuilder
append
- If values
- 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 XmlSchemaSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class XmlSerializerBuilder
values
- 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 XmlSchemaSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class XmlSerializerBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public XmlSchemaSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class XmlSerializerBuilder
values
- The values to add to this property.public XmlSchemaSerializerBuilder pojoSwaps(boolean append, Object... values)
BeanContextBuilder
POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization, and "swap in" the non-serializable class during parsing.
An example of a POJO swap would be a Calendar
object that gets swapped out for an ISO8601 string.
pojoSwaps
in class XmlSerializerBuilder
append
- If values
- The new value for this property.
public XmlSchemaSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public XmlSchemaSerializerBuilder implClasses(Map<String,Class<?>> values)
BeanContextBuilder
For 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 XmlSerializerBuilder
values
- The new value for this property.public <T> XmlSchemaSerializerBuilder implClass(Class<T> interfaceClass, Class<? extends T> implClass)
BeanContextBuilder
implClass
in class XmlSerializerBuilder
T
- The class type of the interface.interfaceClass
- The interface class.implClass
- The implementation class.public XmlSchemaSerializerBuilder beanDictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary
in class XmlSerializerBuilder
values
- The values to add to this property.public XmlSchemaSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class XmlSerializerBuilder
values
- The values to add to this property.public XmlSchemaSerializerBuilder beanDictionary(boolean append, Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but allows you to optionally overwrite the previous value.
beanDictionary
in class XmlSerializerBuilder
append
- If values
- The new values for this property.public XmlSchemaSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.public XmlSchemaSerializerBuilder beanTypePropertyName(String value)
BeanContextBuilder
This 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 XmlSerializerBuilder
value
- The new value for this property.
public XmlSchemaSerializerBuilder locale(Locale value)
BeanContextBuilder
Specifies a default locale for serializer and parser sessions.
locale
in class XmlSerializerBuilder
value
- The new value for this property.public XmlSchemaSerializerBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class XmlSerializerBuilder
value
- The new value for this property.public XmlSchemaSerializerBuilder mediaType(MediaType value)
BeanContextBuilder
Specifies a default media type value for serializer and parser sessions.
mediaType
in class XmlSerializerBuilder
value
- The new value for this property.public XmlSchemaSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class XmlSerializerBuilder
public XmlSchemaSerializerBuilder set(String name, Object value)
ContextBuilder
set
in class XmlSerializerBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public XmlSchemaSerializerBuilder set(boolean append, String name, Object value)
ContextBuilder
set
in class XmlSerializerBuilder
append
- If name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public XmlSchemaSerializerBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class XmlSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public XmlSchemaSerializerBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class XmlSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public XmlSchemaSerializerBuilder addTo(String name, Object value)
ContextBuilder
addTo
in class XmlSerializerBuilder
name
- The property name.value
- The new value to add to the SET property.public XmlSchemaSerializerBuilder addTo(String name, String key, Object value)
ContextBuilder
addTo
in class XmlSerializerBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.public XmlSchemaSerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class XmlSerializerBuilder
name
- The property name.value
- The property value in the SET property.public XmlSchemaSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class XmlSerializerBuilder
copyFrom
- The factory whose settings are being copied.Copyright © 2018 Apache. All rights reserved.