public class SoapXmlSerializerBuilder extends XmlSerializerBuilder
psb
Constructor and Description |
---|
SoapXmlSerializerBuilder()
Constructor, default settings.
|
SoapXmlSerializerBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
SoapXmlSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
SoapXmlSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
SoapXmlSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
SoapXmlSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
SoapXmlSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
SoapXmlSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
SoapXmlSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
SoapXmlSerializerBuilder |
annotations(Annotation... values)
Configuration property: Annotations.
|
SoapXmlSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
SoapXmlSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
SoapXmlSerializerBuilder |
applyAnnotations(Class<?>... fromClasses)
Applies any of the various
|
SoapXmlSerializerBuilder |
applyAnnotations(Method... fromMethods)
Applies any of the various
|
SoapXmlSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
SoapXmlSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
SoapXmlSerializerBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
SoapXmlSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
SoapXmlSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
SoapXmlSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
SoapXmlSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
SoapXmlSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
SoapXmlSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
SoapXmlSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
SoapXmlSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
SoapXmlSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
SoapXmlSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
SoapXmlSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
SoapXmlSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
SoapXmlSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
SoapXmlSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
SoapXmlSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
SoapXmlSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
SoapXmlSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
SoapXmlSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
SoapXmlSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
SoapXmlSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
SoapXmlSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
SoapXmlSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
SoapXmlSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
SoapXmlSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
SoapXmlSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
SoapXmlSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
SoapXmlSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
SoapXmlSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
SoapXmlSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
SoapXmlSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
SoapXmlSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
SoapXmlSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
SoapXmlSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
SoapXmlSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
SoapXmlSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
SoapXmlSerializer |
build()
Build the object.
|
SoapXmlSerializerBuilder |
debug()
Configuration property: Debug mode.
|
SoapXmlSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
SoapXmlSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
SoapXmlSerializerBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
SoapXmlSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
SoapXmlSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
SoapXmlSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
SoapXmlSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
SoapXmlSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
<T> SoapXmlSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> SoapXmlSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
SoapXmlSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
SoapXmlSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
SoapXmlSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
SoapXmlSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
SoapXmlSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
SoapXmlSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
SoapXmlSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
SoapXmlSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
SoapXmlSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
SoapXmlSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
SoapXmlSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
SoapXmlSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
SoapXmlSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
SoapXmlSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
SoapXmlSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
SoapXmlSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
SoapXmlSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
SoapXmlSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
SoapXmlSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
SoapXmlSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
SoapXmlSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
SoapXmlSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
SoapXmlSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
SoapXmlSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
SoapXmlSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
SoapXmlSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
SoapXmlSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
SoapXmlSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
SoapXmlSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
SoapXmlSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
SoapXmlSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
SoapXmlSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
SoapXmlSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
SoapXmlSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
SoapXmlSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
SoapXmlSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
SoapXmlSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
SoapXmlSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
SoapXmlSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
SoapXmlSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
SoapXmlSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
SoapXmlSerializerBuilder |
soapAction(String value)
Configuration property: The
|
SoapXmlSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
SoapXmlSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
SoapXmlSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
SoapXmlSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
SoapXmlSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
SoapXmlSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
SoapXmlSerializerBuilder |
sq()
Configuration property: Quote character.
|
SoapXmlSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
SoapXmlSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
SoapXmlSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
SoapXmlSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
SoapXmlSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
SoapXmlSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
SoapXmlSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
SoapXmlSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
SoapXmlSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
SoapXmlSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
SoapXmlSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
SoapXmlSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
SoapXmlSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
SoapXmlSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
SoapXmlSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
SoapXmlSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
SoapXmlSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
SoapXmlSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
SoapXmlSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
SoapXmlSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
addNamespaceUrisToRoot, addNamespaceUrisToRoot, autoDetectNamespaces, defaultNamespace, enableNamespaces, enableNamespaces, namespaces, namespaces, ns, xsNamespace, xsNamespace
uriContext, uriRelativity, uriResolution
debug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public SoapXmlSerializerBuilder()
public SoapXmlSerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public SoapXmlSerializer build()
ContextBuilder
build
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder soapAction(String value)
value
- The new value for this property.
public SoapXmlSerializerBuilder fileCharset(Charset value)
WriterSerializerBuilder
The character set to use for writing Files to the file system.
Used when passing in files to Serializer.serialize(Object, Object)
.
fileCharset
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder maxIndent(int value)
WriterSerializerBuilder
Specifies the maximum indentation level in the serialized document.
maxIndent
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder quoteChar(char value)
WriterSerializerBuilder
This is the character used for quoting attributes and values.
quoteChar
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(
.
sq
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder streamCharset(Charset value)
WriterSerializerBuilder
The 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 XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
useWhitespace
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
ws
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(
.
addBeanTypes
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder addRootType(boolean value)
SerializerBuilder
When 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 XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(
.
addRootType
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilder
Specifies that recursions should be checked for during traversal.
detectRecursions
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(
.
detectRecursions
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(
.
ignoreRecursions
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder initialDepth(int value)
BeanTraverseBuilder
The initial indentation level at the root.
initialDepth
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(
.
sortCollections
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(
.
sortMaps
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(
.
trimEmptyCollections
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(
.
trimEmptyMaps
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim()
before being serialized.
trimStrings
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(
.
trimStrings
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder annotations(Annotation... values)
BeanContextBuilder
Defines annotations to apply to specific classes and methods.
Allows you to dynamically apply Juneau annotations typically applied directly to classes and methods. Useful in cases where you want to use the functionality of the annotation on beans and bean properties but do not have access to the code to do so.
annotations
in class XmlSerializerBuilder
values
- The values to add to this property.public SoapXmlSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilder
Classes are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility
in class XmlSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public SoapXmlSerializerBuilder 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
.@Deprecated public SoapXmlSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionary(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class XmlSerializerBuilder
values
- The values to add to this property.@Deprecated public SoapXmlSerializerBuilder beanDictionary(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionary(Object...)
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.@Deprecated public SoapXmlSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class XmlSerializerBuilder
values
- The new values for this property.@Deprecated public SoapXmlSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Object...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class XmlSerializerBuilder
values
- The new values for this property.@Deprecated public SoapXmlSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionaryRemove(Class...)
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.@Deprecated public SoapXmlSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionaryRemove(Object...)
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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class XmlSerializerBuilder
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 SoapXmlSerializerBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class XmlSerializerBuilder
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 SoapXmlSerializerBuilder beanFiltersRemove(Class<?>... 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class XmlSerializerBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public SoapXmlSerializerBuilder bpi(Map<String,String> values)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class XmlSerializerBuilder
values
- The new value for this property.public SoapXmlSerializerBuilder bpi(String beanClassName, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class XmlSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public SoapXmlSerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean class.
bpx
in class XmlSerializerBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public SoapXmlSerializerBuilder bpx(Map<String,String> values)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean classes.
bpx
in class XmlSerializerBuilder
values
- The new value for this property.public SoapXmlSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilder
bpx
in class XmlSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public SoapXmlSerializerBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class XmlSerializerBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public SoapXmlSerializerBuilder bpro(Map<String,String> values)
BeanContextBuilder
Specifies the read-only properties for the specified bean classes.
bpro
in class XmlSerializerBuilder
values
- The new value for this property.public SoapXmlSerializerBuilder bpro(String beanClassName, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class XmlSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public SoapXmlSerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class XmlSerializerBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public SoapXmlSerializerBuilder bpwo(Map<String,String> values)
BeanContextBuilder
Specifies the write-only properties for the specified bean classes.
bpwo
in class XmlSerializerBuilder
values
- The new value for this property.public SoapXmlSerializerBuilder bpwo(String beanClassName, String value)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class XmlSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public SoapXmlSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
dictionary
in class XmlSerializerBuilder
values
- The values to add to this property.public SoapXmlSerializerBuilder dictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
dictionary
in class XmlSerializerBuilder
values
- The values to add to this property.public SoapXmlSerializerBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class XmlSerializerBuilder
values
- The new values for this property.public SoapXmlSerializerBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class XmlSerializerBuilder
values
- The new values for this property.public SoapXmlSerializerBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.public SoapXmlSerializerBuilder dictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.public <T> SoapXmlSerializerBuilder example(Class<T> c, T o)
BeanContextBuilder
Specifies an example of the specified class.
example
in class XmlSerializerBuilder
c
- The POJO class.o
- An instance of the POJO class used for examples.public <T> SoapXmlSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilder
Specifies an example of the specified class.
exampleJson
in class XmlSerializerBuilder
T
- The POJO class type.c
- The POJO class.value
- The simple JSON representation of the example.public SoapXmlSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilder
implClass
in class XmlSerializerBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 XmlSerializerBuilder
values
- The values to add to this property.public SoapXmlSerializerBuilder 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 XmlSerializerBuilder
values
- The values to add to this property.
public SoapXmlSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class XmlSerializerBuilder
values
- The new value for this property.public SoapXmlSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class XmlSerializerBuilder
values
- The new value for this property.
public SoapXmlSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuilder
notBeanClassesRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.public SoapXmlSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.
public SoapXmlSerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class XmlSerializerBuilder
values
- The values to add to this property.
public SoapXmlSerializerBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class XmlSerializerBuilder
values
- The values to add to this property.public SoapXmlSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuilder
notBeanPackagesReplace
in class XmlSerializerBuilder
values
- public SoapXmlSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuilder
notBeanPackagesReplace
in class XmlSerializerBuilder
values
- public SoapXmlSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuilder
notBeanPackagesRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.public SoapXmlSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class XmlSerializerBuilder
values
- public SoapXmlSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class XmlSerializerBuilder
values
- The values to add to this property.public SoapXmlSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class XmlSerializerBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public SoapXmlSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilder
pojoSwapsReplace
in class XmlSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public SoapXmlSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilder
pojoSwapsReplace
in class XmlSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public SoapXmlSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilder
pojoSwapsRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public SoapXmlSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class XmlSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public SoapXmlSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class XmlSerializerBuilder
value
- The new value for this property.
public SoapXmlSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class XmlSerializerBuilder
value
- The new value for this property.public SoapXmlSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class XmlSerializerBuilder
value
- The property value.public SoapXmlSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class XmlSerializerBuilder
public SoapXmlSerializerBuilder set(String name, Object value)
ContextBuilder
set
in class XmlSerializerBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public SoapXmlSerializerBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class XmlSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public SoapXmlSerializerBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class XmlSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder 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 SoapXmlSerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class XmlSerializerBuilder
name
- The property name.value
- The property value in the SET property.public SoapXmlSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class XmlSerializerBuilder
copyFrom
- The factory whose settings are being copied.public SoapXmlSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilder
applyAnnotations
in class XmlSerializerBuilder
al
- The list of all annotations annotated with PropertyStoreApply
.vrs
- The string resolver for resolving variables in annotation values.public SoapXmlSerializerBuilder applyAnnotations(Class<?>... fromClasses)
ContextBuilder
Applies 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 XmlSerializerBuilder
fromClasses
- The classes on which the annotations are defined.public SoapXmlSerializerBuilder applyAnnotations(Method... fromMethods)
ContextBuilder
Applies 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 XmlSerializerBuilder
fromMethods
- The methods on which the annotations are defined.Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.