public class XmlSchemaSerializerBuilder extends XmlSerializerBuilder
psb| Constructor and Description |
|---|
XmlSchemaSerializerBuilder()
Constructor, default settings.
|
XmlSchemaSerializerBuilder(PropertyStore ps)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
XmlSchemaSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
XmlSchemaSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
XmlSchemaSerializerBuilder |
addBeanTypes(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 |
addRootType()
Configuration property: Add type attribute to root nodes.
|
XmlSchemaSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
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 |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
XmlSchemaSerializerBuilder |
applyAnnotations(Class<?> fromClass)
Applies any of the various
|
XmlSchemaSerializerBuilder |
applyAnnotations(Method fromMethod)
Applies any of the various
|
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(Class<?>... values)
Deprecated.
|
XmlSchemaSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
XmlSchemaSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
XmlSchemaSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
XmlSchemaSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
XmlSchemaSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
XmlSchemaSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
XmlSchemaSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
XmlSchemaSerializerBuilder |
beanFiltersReplace(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.
|
XmlSchemaSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
XmlSchemaSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
XmlSchemaSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
XmlSchemaSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
XmlSchemaSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
XmlSchemaSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
XmlSchemaSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
XmlSchemaSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
XmlSchemaSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
XmlSchemaSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
XmlSchemaSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
XmlSchemaSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
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 |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
XmlSchemaSerializerBuilder |
enableNamespaces(boolean value)
Configuration property: Enable support for XML namespaces.
|
<T> XmlSchemaSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> XmlSchemaSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
XmlSchemaSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
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.
|
XmlSchemaSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> 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 traversal 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(Class<?>... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
XmlSchemaSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class 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 |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
XmlSchemaSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
XmlSchemaSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
XmlSchemaSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
XmlSchemaSerializerBuilder |
pojoSwapsReplace(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(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 |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
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 |
useEnumNames()
Configuration property: Use enum names.
|
XmlSchemaSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
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, namespaces, ns, xsNamespaceuriContext, uriRelativity, uriResolutiondebug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamerbuild, getPropertyStore, getPropertyStoreBuilder, peek, peekpublic XmlSchemaSerializerBuilder()
public XmlSchemaSerializerBuilder(PropertyStore ps)
ps - The initial configuration settings for this builder.public XmlSchemaSerializer build()
ContextBuilderbuild in class XmlSerializerBuilderpublic 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder addNamespaceUrisToRoot()
XmlSerializerBuilder
Shortcut for calling addNamespaceUrisToRoot(.
addNamespaceUrisToRoot in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder autoDetectNamespaces(boolean value)
XmlSerializerBuilderDetect namespace usage before serialization.
autoDetectNamespaces in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder defaultNamespace(String value)
XmlSerializerBuilderSpecifies the default namespace URI for this document.
defaultNamespace in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder enableNamespaces(boolean value)
XmlSerializerBuilderIf not enabled, XML output will not contain any namespaces regardless of any other settings.
enableNamespaces in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder namespaces(Namespace... values)
XmlSerializerBuilderThe default list of namespaces associated with this serializer.
namespaces in class XmlSerializerBuildervalues - The new value for this property.public XmlSchemaSerializerBuilder xsNamespace(Namespace value)
XmlSerializerBuilder
Specifies the namespace for the XmlSchemaSerializer class.
xsNamespace in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder maxIndent(int value)
WriterSerializerBuilderSpecifies the maximum indentation level in the serialized document.
maxIndent in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder quoteChar(char value)
WriterSerializerBuilderThis is the character used for quoting attributes and values.
quoteChar in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(.
sq in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
useWhitespace in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
ws in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(.
addBeanTypes in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(.
addRootType in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilderSpecifies that recursions should be checked for during traversal.
detectRecursions in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(.
detectRecursions in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(.
ignoreRecursions in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder initialDepth(int value)
BeanTraverseBuilderThe initial indentation level at the root.
initialDepth in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilderClass used to listen for errors and warnings that occur during serialization.
listener in class XmlSerializerBuildervalue - The new value for this property.public XmlSchemaSerializerBuilder 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder sortCollections(boolean value)
SerializerBuilderCopies and sorts the contents of arrays and collections before serializing them.
sortCollections in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(.
sortCollections in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder sortMaps(boolean value)
SerializerBuilderCopies and sorts the contents of maps before serializing them.
sortMaps in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(.
sortMaps in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(.
trimEmptyCollections in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(.
trimEmptyMaps in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim() before being serialized.
trimStrings in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(.
trimStrings in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder uriContext(UriContext value)
SerializerBuilderBean used for resolution of URIs to absolute or root-relative form.
uriContext in class XmlSerializerBuildervalue - The new value for this property.public XmlSchemaSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilderDefines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity in class XmlSerializerBuildervalue - The new value for this property.
UriRelativity.RESOURCEpublic XmlSchemaSerializerBuilder uriResolution(UriResolution value)
SerializerBuilderDefines the resolution level for URIs when serializing URI/URL objects.
uriResolution in class XmlSerializerBuildervalue - The new value for this property.
UriResolution.NONEpublic XmlSchemaSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilderClasses are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility in class XmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public XmlSchemaSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilderOnly look for constructors with the specified minimum visibility.
beanConstructorVisibility in class XmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.@Deprecated public XmlSchemaSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
beanDictionary in class XmlSerializerBuildervalues - The values to add to this property.@Deprecated public XmlSchemaSerializerBuilder beanDictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary in class XmlSerializerBuildervalues - The values to add to this property.@Deprecated public XmlSchemaSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class XmlSerializerBuildervalues - The new values for this property.@Deprecated public XmlSchemaSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class XmlSerializerBuildervalues - The new values for this property.@Deprecated public XmlSchemaSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class XmlSerializerBuildervalues - The values to remove from this property.@Deprecated public XmlSchemaSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class XmlSerializerBuildervalues - The values to remove from this property.public XmlSchemaSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilderOnly look for bean fields with the specified minimum visibility.
beanFieldVisibility in class XmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public XmlSchemaSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but takes in an array of classes.
beanFilters in class XmlSerializerBuildervalues - The values to add to 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 XmlSerializerBuildervalues - 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 beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class XmlSerializerBuildervalues - 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 beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class XmlSerializerBuildervalues - 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(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class XmlSerializerBuildervalues - 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 beanFiltersRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class XmlSerializerBuildervalues - 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 beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put() method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(.
beanMapPutReturnsOldValue in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilderOnly look for bean methods with the specified minimum visibility.
beanMethodVisibility in class XmlSerializerBuildervalue - The new value for this property.
Visibility.PUBLICpublic XmlSchemaSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireDefaultConstructor in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(.
beansRequireDefaultConstructor in class XmlSerializerBuilderpublic 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(.
beansRequireSerializable in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(.
beansRequireSettersForGetters in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSomeProperties in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class XmlSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public XmlSchemaSerializerBuilder bpi(Map<String,String> values)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class XmlSerializerBuildervalues - The new value for this property.public XmlSchemaSerializerBuilder bpi(String beanClassName, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class XmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public XmlSchemaSerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean class.
bpx in class XmlSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public XmlSchemaSerializerBuilder bpx(Map<String,String> values)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean classes.
bpx in class XmlSerializerBuildervalues - The new value for this property.public XmlSchemaSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilderbpx in class XmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public XmlSchemaSerializerBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class XmlSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public XmlSchemaSerializerBuilder bpro(Map<String,String> values)
BeanContextBuilderSpecifies the read-only properties for the specified bean classes.
bpro in class XmlSerializerBuildervalues - The new value for this property.public XmlSchemaSerializerBuilder bpro(String beanClassName, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class XmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public XmlSchemaSerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class XmlSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public XmlSchemaSerializerBuilder bpwo(Map<String,String> values)
BeanContextBuilderSpecifies the write-only properties for the specified bean classes.
bpwo in class XmlSerializerBuildervalues - The new value for this property.public XmlSchemaSerializerBuilder bpwo(String beanClassName, String value)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class XmlSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public XmlSchemaSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(.
debug in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
dictionary in class XmlSerializerBuildervalues - The values to add to this property.public XmlSchemaSerializerBuilder dictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
dictionary in class XmlSerializerBuildervalues - The values to add to this property.public XmlSchemaSerializerBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class XmlSerializerBuildervalues - The new values for this property.public XmlSchemaSerializerBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class XmlSerializerBuildervalues - The new values for this property.public XmlSchemaSerializerBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class XmlSerializerBuildervalues - The values to remove from this property.public XmlSchemaSerializerBuilder dictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class XmlSerializerBuildervalues - The values to remove from this property.public <T> XmlSchemaSerializerBuilder example(Class<T> c, T o)
BeanContextBuilderSpecifies an example of the specified class.
example in class XmlSerializerBuilderc - The POJO class.o - An instance of the POJO class used for examples.public <T> XmlSchemaSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilderSpecifies an example of the specified class.
exampleJson in class XmlSerializerBuilderT - The POJO class type.c - The POJO class.value - The simple JSON representation of the example.public XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnGetters in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(.
ignoreInvocationExceptionsOnGetters in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnSetters in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(.
ignoreInvocationExceptionsOnSetters in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignorePropertiesWithoutSetters in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownBeanProperties in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(.
ignoreUnknownBeanProperties in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownNullBeanProperties in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilderimplClass in class XmlSerializerBuilderinterfaceClass - The interface class.implClass - The implementation class.public XmlSchemaSerializerBuilder 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 XmlSerializerBuildervalues - The new value for this property.public XmlSchemaSerializerBuilder locale(Locale value)
BeanContextBuilderSpecifies a default locale for serializer and parser sessions.
locale in class XmlSerializerBuildervalue - The new value for this property.public XmlSchemaSerializerBuilder mediaType(MediaType value)
BeanContextBuilderSpecifies a default media type value for serializer and parser sessions.
mediaType in class XmlSerializerBuildervalue - The new value for 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
notBeanClasses in class XmlSerializerBuildervalues - The values to add to this property.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
notBeanClasses in class XmlSerializerBuildervalues - The values to add to this property.
public XmlSchemaSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class XmlSerializerBuildervalues - The new value for this property.public XmlSchemaSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class XmlSerializerBuildervalues - The new value for this property.
public XmlSchemaSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuildernotBeanClassesRemove in class XmlSerializerBuildervalues - The values to remove from this property.public XmlSchemaSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuildernotBeanClassesRemove in class XmlSerializerBuildervalues - The values to remove from this property.
public XmlSchemaSerializerBuilder notBeanPackages(Object... values)
BeanContextBuildernotBeanPackages in class XmlSerializerBuildervalues - The values to add to this property.
public XmlSchemaSerializerBuilder notBeanPackages(String... values)
BeanContextBuildernotBeanPackages in class XmlSerializerBuildervalues - The values to add to this property.public XmlSchemaSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuildernotBeanPackagesReplace in class XmlSerializerBuildervalues - public XmlSchemaSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuildernotBeanPackagesReplace in class XmlSerializerBuildervalues - public XmlSchemaSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuildernotBeanPackagesRemove in class XmlSerializerBuildervalues - The values to remove from this property.public XmlSchemaSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuildernotBeanPackagesRemove in class XmlSerializerBuildervalues - public XmlSchemaSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilderpojoSwaps in class XmlSerializerBuildervalues - The values to add to this property.public XmlSchemaSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilderpojoSwaps in class XmlSerializerBuildervalues - The values to add to this property.
PojoSwap.
SurrogateSwap.
public XmlSchemaSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilderpojoSwapsReplace in class XmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public XmlSchemaSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilderpojoSwapsReplace in class XmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public XmlSchemaSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilderpojoSwapsRemove in class XmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public XmlSchemaSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilderpojoSwapsRemove in class XmlSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public XmlSchemaSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(.
sortProperties in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder timeZone(TimeZone value)
BeanContextBuildertimeZone in class XmlSerializerBuildervalue - The new value for this property.public XmlSchemaSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class XmlSerializerBuildervalue - The property value.public XmlSchemaSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler if there is no other way of instantiating them.
useInterfaceProxies in class XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder 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 XmlSerializerBuildervalue - The new value for this property.
public XmlSchemaSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(.
useJavaBeanIntrospector in class XmlSerializerBuilderpublic XmlSchemaSerializerBuilder set(String name, Object value)
ContextBuilderset in class XmlSerializerBuildername - The property name.value - The property value.PropertyStoreBuilder.set(String, Object)public XmlSchemaSerializerBuilder set(Map<String,Object> properties)
ContextBuilderset in class XmlSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)public XmlSchemaSerializerBuilder add(Map<String,Object> properties)
ContextBuilderadd in class XmlSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)public XmlSchemaSerializerBuilder addTo(String name, Object value)
ContextBuilderaddTo in class XmlSerializerBuildername - The property name.value - The new value to add to the SET property.public XmlSchemaSerializerBuilder addTo(String name, String key, Object value)
ContextBuilderaddTo in class XmlSerializerBuildername - The property name.key - The property value map key.value - The property value map value.public XmlSchemaSerializerBuilder removeFrom(String name, Object value)
ContextBuilderremoveFrom in class XmlSerializerBuildername - The property name.value - The property value in the SET property.public XmlSchemaSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilderapply in class XmlSerializerBuildercopyFrom - The factory whose settings are being copied.public XmlSchemaSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilderapplyAnnotations in class XmlSerializerBuilderal - The list of all annotations annotated with PropertyStoreApply.vrs - The string resolver for resolving variables in annotation values.public XmlSchemaSerializerBuilder 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 XmlSerializerBuilderfromClass - The class on which the annotations are defined.public XmlSchemaSerializerBuilder 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 XmlSerializerBuilderfromMethod - The method on which the annotations are defined.Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.