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