public class UrlEncodingSerializerBuilder extends UonSerializerBuilder
psb
Constructor and Description |
---|
UrlEncodingSerializerBuilder()
Constructor, default settings.
|
UrlEncodingSerializerBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
UrlEncodingSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
UrlEncodingSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
UrlEncodingSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
UrlEncodingSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
UrlEncodingSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
UrlEncodingSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
UrlEncodingSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
UrlEncodingSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
UrlEncodingSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
UrlEncodingSerializerBuilder |
applyAnnotations(Class<?> fromClass)
Applies any of the various
|
UrlEncodingSerializerBuilder |
applyAnnotations(Method fromMethod)
Applies any of the various
|
UrlEncodingSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
UrlEncodingSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
UrlEncodingSerializerBuilder |
beanDictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
UrlEncodingSerializerBuilder |
beanDictionary(Object... values)
Configuration property: Bean dictionary.
|
UrlEncodingSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
UrlEncodingSerializerBuilder |
beanDictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
UrlEncodingSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
UrlEncodingSerializerBuilder |
beanDictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
UrlEncodingSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
UrlEncodingSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
UrlEncodingSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
UrlEncodingSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
UrlEncodingSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
UrlEncodingSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
UrlEncodingSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
UrlEncodingSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
UrlEncodingSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
UrlEncodingSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
UrlEncodingSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
UrlEncodingSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
UrlEncodingSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
UrlEncodingSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
UrlEncodingSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
UrlEncodingSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
UrlEncodingSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
UrlEncodingSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
UrlEncodingSerializer |
build()
Build the object.
|
UrlEncodingSerializerBuilder |
debug()
Configuration property: Debug mode.
|
UrlEncodingSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
UrlEncodingSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
UrlEncodingSerializerBuilder |
encoding()
Configuration property: Encode non-valid URI characters.
|
UrlEncodingSerializerBuilder |
encoding(boolean value)
Configuration property: Encode non-valid URI characters.
|
<T> UrlEncodingSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> UrlEncodingSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
UrlEncodingSerializerBuilder |
expandedParams()
Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
|
UrlEncodingSerializerBuilder |
expandedParams(boolean value)
Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
|
UrlEncodingSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
UrlEncodingSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
UrlEncodingSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
UrlEncodingSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
UrlEncodingSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
UrlEncodingSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
UrlEncodingSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
UrlEncodingSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
UrlEncodingSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
UrlEncodingSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
UrlEncodingSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
UrlEncodingSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
UrlEncodingSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
UrlEncodingSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
UrlEncodingSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
UrlEncodingSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
UrlEncodingSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
UrlEncodingSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
UrlEncodingSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
UrlEncodingSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
UrlEncodingSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
UrlEncodingSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
UrlEncodingSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
UrlEncodingSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
UrlEncodingSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
UrlEncodingSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
UrlEncodingSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
UrlEncodingSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
UrlEncodingSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
UrlEncodingSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
UrlEncodingSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
UrlEncodingSerializerBuilder |
paramFormat(ParamFormat paramFormat)
Configuration property: Format to use for query/form-data/header values.
|
UrlEncodingSerializerBuilder |
paramFormatPlain()
Configuration property: Format to use for query/form-data/header values.
|
UrlEncodingSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
UrlEncodingSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
UrlEncodingSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
UrlEncodingSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
UrlEncodingSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
UrlEncodingSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
UrlEncodingSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
UrlEncodingSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
UrlEncodingSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
UrlEncodingSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
UrlEncodingSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
UrlEncodingSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
UrlEncodingSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
UrlEncodingSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
UrlEncodingSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
UrlEncodingSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
UrlEncodingSerializerBuilder |
sq()
Configuration property: Quote character.
|
UrlEncodingSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
UrlEncodingSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
UrlEncodingSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
UrlEncodingSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
UrlEncodingSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
UrlEncodingSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
UrlEncodingSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
UrlEncodingSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
UrlEncodingSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
UrlEncodingSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
UrlEncodingSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
UrlEncodingSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
UrlEncodingSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
UrlEncodingSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
UrlEncodingSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
UrlEncodingSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
UrlEncodingSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
UrlEncodingSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
UrlEncodingSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
UrlEncodingSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
paramFormat
uriContext, uriRelativity, uriResolution
debug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public UrlEncodingSerializerBuilder()
public UrlEncodingSerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public UrlEncodingSerializer build()
ContextBuilder
build
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder expandedParams(boolean value)
If
If
value
- The new value for this property.
public UrlEncodingSerializerBuilder expandedParams()
Shortcut for calling expandedParams(
.
public UrlEncodingSerializerBuilder encoding(boolean value)
UonSerializerBuilder
Encode non-valid URI characters with
encoding
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder encoding()
UonSerializerBuilder
Shortcut for calling encoding(
.
encoding
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder paramFormat(ParamFormat paramFormat)
UonSerializerBuilder
Specifies the format to use for URL GET parameter keys and values.
paramFormat
in class UonSerializerBuilder
paramFormat
- The new value for this property.
ParamFormat.UON
.public UrlEncodingSerializerBuilder paramFormatPlain()
UonSerializerBuilder
Shortcut for calling paramFormat(
.
paramFormatPlain
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder maxIndent(int value)
WriterSerializerBuilder
Specifies the maximum indentation level in the serialized document.
maxIndent
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder quoteChar(char value)
WriterSerializerBuilder
This is the character used for quoting attributes and values.
quoteChar
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(
.
sq
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
useWhitespace
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
ws
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(
.
addBeanTypes
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(
.
addRootType
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilder
Specifies that recursions should be checked for during traversal.
detectRecursions
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(
.
detectRecursions
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(
.
ignoreRecursions
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder initialDepth(int value)
BeanTraverseBuilder
The initial indentation level at the root.
initialDepth
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilder
Class used to listen for errors and warnings that occur during serialization.
listener
in class UonSerializerBuilder
value
- The new value for this property.public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder sortCollections(boolean value)
SerializerBuilder
Copies and sorts the contents of arrays and collections before serializing them.
sortCollections
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(
.
sortCollections
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder sortMaps(boolean value)
SerializerBuilder
Copies and sorts the contents of maps before serializing them.
sortMaps
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(
.
sortMaps
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(
.
trimEmptyCollections
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(
.
trimEmptyMaps
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim()
before being serialized.
trimStrings
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(
.
trimStrings
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder uriContext(UriContext value)
SerializerBuilder
Bean used for resolution of URIs to absolute or root-relative form.
uriContext
in class UonSerializerBuilder
value
- The new value for this property.public UrlEncodingSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilder
Defines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity
in class UonSerializerBuilder
value
- The new value for this property.
UriRelativity.RESOURCE
public UrlEncodingSerializerBuilder uriResolution(UriResolution value)
SerializerBuilder
Defines the resolution level for URIs when serializing URI/URL objects.
uriResolution
in class UonSerializerBuilder
value
- The new value for this property.
UriResolution.NONE
public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public UrlEncodingSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
beanConstructorVisibility
in class UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public UrlEncodingSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class UonSerializerBuilder
values
- The values to add to this property.public UrlEncodingSerializerBuilder beanDictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary
in class UonSerializerBuilder
values
- The values to add to this property.public UrlEncodingSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class UonSerializerBuilder
values
- The new values for this property.public UrlEncodingSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class UonSerializerBuilder
values
- The new values for this property.public UrlEncodingSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class UonSerializerBuilder
values
- The values to remove from this property.public UrlEncodingSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class UonSerializerBuilder
values
- The values to remove from this property.public UrlEncodingSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
beanFieldVisibility
in class UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public UrlEncodingSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but takes in an array of classes.
beanFilters
in class UonSerializerBuilder
values
- The values to add to this property.public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
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 UrlEncodingSerializerBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class UonSerializerBuilder
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 UrlEncodingSerializerBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class UonSerializerBuilder
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 UrlEncodingSerializerBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class UonSerializerBuilder
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 UrlEncodingSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class UonSerializerBuilder
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 UrlEncodingSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put()
method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
beanMethodVisibility
in class UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
public UrlEncodingSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireDefaultConstructor
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSomeProperties
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class UonSerializerBuilder
public <T> UrlEncodingSerializerBuilder example(Class<T> c, T o)
BeanContextBuilder
Specifies an example of the specified class.
example
in class UonSerializerBuilder
c
- The POJO class.o
- An instance of the POJO class used for examples.public <T> UrlEncodingSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilder
Specifies an example of the specified class.
exampleJson
in class UonSerializerBuilder
T
- The POJO class type.c
- The POJO class.value
- The simple JSON representation of the example.public UrlEncodingSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilder
implClass
in class UonSerializerBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
values
- The new value for this property.public UrlEncodingSerializerBuilder locale(Locale value)
BeanContextBuilder
Specifies a default locale for serializer and parser sessions.
locale
in class UonSerializerBuilder
value
- The new value for this property.public UrlEncodingSerializerBuilder mediaType(MediaType value)
BeanContextBuilder
Specifies a default media type value for serializer and parser sessions.
mediaType
in class UonSerializerBuilder
value
- The new value for this property.public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
values
- The values to add to this property.public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
values
- The values to add to this property.
public UrlEncodingSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class UonSerializerBuilder
values
- The new value for this property.public UrlEncodingSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class UonSerializerBuilder
values
- The new value for this property.
public UrlEncodingSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuilder
notBeanClassesRemove
in class UonSerializerBuilder
values
- The values to remove from this property.public UrlEncodingSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class UonSerializerBuilder
values
- The values to remove from this property.
public UrlEncodingSerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class UonSerializerBuilder
values
- The values to add to this property.
public UrlEncodingSerializerBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class UonSerializerBuilder
values
- The values to add to this property.public UrlEncodingSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuilder
notBeanPackagesReplace
in class UonSerializerBuilder
values
- public UrlEncodingSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuilder
notBeanPackagesReplace
in class UonSerializerBuilder
values
- public UrlEncodingSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuilder
notBeanPackagesRemove
in class UonSerializerBuilder
values
- The values to remove from this property.public UrlEncodingSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class UonSerializerBuilder
values
- public UrlEncodingSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class UonSerializerBuilder
values
- The values to add to this property.public UrlEncodingSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class UonSerializerBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public UrlEncodingSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilder
pojoSwapsReplace
in class UonSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public UrlEncodingSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilder
pojoSwapsReplace
in class UonSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public UrlEncodingSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilder
pojoSwapsRemove
in class UonSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public UrlEncodingSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class UonSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public UrlEncodingSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class UonSerializerBuilder
value
- The new value for this property.public UrlEncodingSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class UonSerializerBuilder
value
- The property value.public UrlEncodingSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler
if there is no other way of instantiating them.
useInterfaceProxies
in class UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder 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 UonSerializerBuilder
value
- The new value for this property.
public UrlEncodingSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class UonSerializerBuilder
public UrlEncodingSerializerBuilder set(String name, Object value)
ContextBuilder
set
in class UonSerializerBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public UrlEncodingSerializerBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class UonSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public UrlEncodingSerializerBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class UonSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public UrlEncodingSerializerBuilder addTo(String name, Object value)
ContextBuilder
addTo
in class UonSerializerBuilder
name
- The property name.value
- The new value to add to the SET property.public UrlEncodingSerializerBuilder addTo(String name, String key, Object value)
ContextBuilder
addTo
in class UonSerializerBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.public UrlEncodingSerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class UonSerializerBuilder
name
- The property name.value
- The property value in the SET property.public UrlEncodingSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class UonSerializerBuilder
copyFrom
- The factory whose settings are being copied.public UrlEncodingSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilder
applyAnnotations
in class UonSerializerBuilder
al
- The list of all annotations annotated with PropertyStoreApply
.vrs
- The string resolver for resolving variables in annotation values.public UrlEncodingSerializerBuilder applyAnnotations(Class<?> fromClass)
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 UonSerializerBuilder
fromClass
- The class on which the annotations are defined.public UrlEncodingSerializerBuilder applyAnnotations(Method fromMethod)
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 UonSerializerBuilder
fromMethod
- The method on which the annotations are defined.Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.