public class MsgPackSerializerBuilder extends OutputStreamSerializerBuilder
psb| Constructor and Description |
|---|
MsgPackSerializerBuilder()
Constructor, default settings.
|
MsgPackSerializerBuilder(PropertyStore ps)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
MsgPackSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
MsgPackSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
MsgPackSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
MsgPackSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
MsgPackSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
MsgPackSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
MsgPackSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
MsgPackSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
MsgPackSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
MsgPackSerializerBuilder |
applyAnnotations(Class<?> fromClass)
Applies any of the various
|
MsgPackSerializerBuilder |
applyAnnotations(Method fromMethod)
Applies any of the various
|
MsgPackSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
MsgPackSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
MsgPackSerializerBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
MsgPackSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
MsgPackSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
MsgPackSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
MsgPackSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
MsgPackSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
MsgPackSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
MsgPackSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
MsgPackSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
MsgPackSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
MsgPackSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
MsgPackSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
MsgPackSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
MsgPackSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
MsgPackSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
MsgPackSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
MsgPackSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
MsgPackSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
MsgPackSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
MsgPackSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
MsgPackSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
MsgPackSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
MsgPackSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
MsgPackSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
MsgPackSerializerBuilder |
binaryFormat(BinaryFormat value)
Configuration property: Binary output format.
|
MsgPackSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
MsgPackSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
MsgPackSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
MsgPackSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
MsgPackSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
MsgPackSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
MsgPackSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
MsgPackSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
MsgPackSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
MsgPackSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
MsgPackSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
MsgPackSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
MsgPackSerializer |
build()
Build the object.
|
MsgPackSerializerBuilder |
debug()
Configuration property: Debug mode.
|
MsgPackSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
MsgPackSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
MsgPackSerializerBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
MsgPackSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
MsgPackSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
MsgPackSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
MsgPackSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
MsgPackSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
<T> MsgPackSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> MsgPackSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
MsgPackSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
MsgPackSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
MsgPackSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
MsgPackSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
MsgPackSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
MsgPackSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
MsgPackSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
MsgPackSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
MsgPackSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
MsgPackSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
MsgPackSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
MsgPackSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
MsgPackSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
MsgPackSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
MsgPackSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
MsgPackSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
MsgPackSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
MsgPackSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
MsgPackSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
MsgPackSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
MsgPackSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
MsgPackSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
MsgPackSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
MsgPackSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
MsgPackSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
MsgPackSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
MsgPackSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
MsgPackSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
MsgPackSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
MsgPackSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
MsgPackSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
MsgPackSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
MsgPackSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
MsgPackSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
MsgPackSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
MsgPackSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
MsgPackSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
MsgPackSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
MsgPackSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
MsgPackSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
MsgPackSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
MsgPackSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
MsgPackSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
MsgPackSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
MsgPackSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
MsgPackSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
MsgPackSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
MsgPackSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
MsgPackSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
MsgPackSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
MsgPackSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
MsgPackSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
MsgPackSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
MsgPackSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
MsgPackSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
MsgPackSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
MsgPackSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
MsgPackSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
MsgPackSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
MsgPackSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
binaryFormaturiContext, uriRelativity, uriResolutiondebug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamerbuild, getPropertyStore, getPropertyStoreBuilder, peek, peekpublic MsgPackSerializerBuilder()
public MsgPackSerializerBuilder(PropertyStore ps)
ps - The initial configuration settings for this builder.public MsgPackSerializer build()
ContextBuilderbuild in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder binaryFormat(BinaryFormat value)
OutputStreamSerializerBuilder
When using the Serializer.serializeToString(Object) method on stream-based serializers, this defines the format to use
when converting the resulting byte array to a string.
binaryFormat in class OutputStreamSerializerBuildervalue - The new value for this property.
BinaryFormat.HEX.public MsgPackSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(.
addBeanTypes in class SerializerBuilderpublic MsgPackSerializerBuilder 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 MsgPackSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(.
addRootType in class SerializerBuilderpublic MsgPackSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilderSpecifies that recursions should be checked for during traversal.
detectRecursions in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(.
detectRecursions in class SerializerBuilderpublic MsgPackSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(.
ignoreRecursions in class SerializerBuilderpublic MsgPackSerializerBuilder initialDepth(int value)
BeanTraverseBuilderThe initial indentation level at the root.
initialDepth in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder 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 MsgPackSerializerBuilder 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 MsgPackSerializerBuilder 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 MsgPackSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(.
sortCollections in class SerializerBuilderpublic MsgPackSerializerBuilder sortMaps(boolean value)
SerializerBuilderCopies and sorts the contents of maps before serializing them.
sortMaps in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(.
sortMaps in class SerializerBuilderpublic MsgPackSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(.
trimEmptyCollections in class SerializerBuilderpublic MsgPackSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(.
trimEmptyMaps in class SerializerBuilderpublic MsgPackSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim() before being serialized.
trimStrings in class SerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(.
trimStrings in class SerializerBuilderpublic MsgPackSerializerBuilder 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 MsgPackSerializerBuilder 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 MsgPackSerializerBuilder 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 MsgPackSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilderClasses are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility in class OutputStreamSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public MsgPackSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilderOnly look for constructors with the specified minimum visibility.
beanConstructorVisibility in class OutputStreamSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.@Deprecated public MsgPackSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
beanDictionary in class OutputStreamSerializerBuildervalues - The values to add to this property.@Deprecated public MsgPackSerializerBuilder beanDictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary in class OutputStreamSerializerBuildervalues - The values to add to this property.@Deprecated public MsgPackSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class OutputStreamSerializerBuildervalues - The new values for this property.@Deprecated public MsgPackSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class OutputStreamSerializerBuildervalues - The new values for this property.@Deprecated public MsgPackSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.@Deprecated public MsgPackSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.public MsgPackSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilderOnly look for bean fields with the specified minimum visibility.
beanFieldVisibility in class OutputStreamSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public MsgPackSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but takes in an array of classes.
beanFilters in class OutputStreamSerializerBuildervalues - The values to add to this property.public MsgPackSerializerBuilder 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 OutputStreamSerializerBuildervalues - 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 MsgPackSerializerBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class OutputStreamSerializerBuildervalues - 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 MsgPackSerializerBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class OutputStreamSerializerBuildervalues - 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 MsgPackSerializerBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class OutputStreamSerializerBuildervalues - 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 MsgPackSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class OutputStreamSerializerBuildervalues - 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 MsgPackSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put() method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(.
beanMapPutReturnsOldValue in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilderOnly look for bean methods with the specified minimum visibility.
beanMethodVisibility in class OutputStreamSerializerBuildervalue - The new value for this property.
Visibility.PUBLICpublic MsgPackSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireDefaultConstructor in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(.
beansRequireDefaultConstructor in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder 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 OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(.
beansRequireSerializable in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(.
beansRequireSettersForGetters in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSomeProperties in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder 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 OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class OutputStreamSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public MsgPackSerializerBuilder bpi(Map<String,String> values)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class OutputStreamSerializerBuildervalues - The new value for this property.public MsgPackSerializerBuilder bpi(String beanClassName, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class OutputStreamSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public MsgPackSerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean class.
bpx in class OutputStreamSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public MsgPackSerializerBuilder bpx(Map<String,String> values)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean classes.
bpx in class OutputStreamSerializerBuildervalues - The new value for this property.public MsgPackSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilderbpx in class OutputStreamSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public MsgPackSerializerBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class OutputStreamSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public MsgPackSerializerBuilder bpro(Map<String,String> values)
BeanContextBuilderSpecifies the read-only properties for the specified bean classes.
bpro in class OutputStreamSerializerBuildervalues - The new value for this property.public MsgPackSerializerBuilder bpro(String beanClassName, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class OutputStreamSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public MsgPackSerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class OutputStreamSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public MsgPackSerializerBuilder bpwo(Map<String,String> values)
BeanContextBuilderSpecifies the write-only properties for the specified bean classes.
bpwo in class OutputStreamSerializerBuildervalues - The new value for this property.public MsgPackSerializerBuilder bpwo(String beanClassName, String value)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class OutputStreamSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public MsgPackSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(.
debug in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
dictionary in class OutputStreamSerializerBuildervalues - The values to add to this property.public MsgPackSerializerBuilder dictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
dictionary in class OutputStreamSerializerBuildervalues - The values to add to this property.public MsgPackSerializerBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class OutputStreamSerializerBuildervalues - The new values for this property.public MsgPackSerializerBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class OutputStreamSerializerBuildervalues - The new values for this property.public MsgPackSerializerBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.public MsgPackSerializerBuilder dictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.public <T> MsgPackSerializerBuilder example(Class<T> c, T o)
BeanContextBuilderSpecifies an example of the specified class.
example in class OutputStreamSerializerBuilderc - The POJO class.o - An instance of the POJO class used for examples.public <T> MsgPackSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilderSpecifies an example of the specified class.
exampleJson in class OutputStreamSerializerBuilderT - The POJO class type.c - The POJO class.value - The simple JSON representation of the example.public MsgPackSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnGetters in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(.
ignoreInvocationExceptionsOnGetters in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnSetters in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(.
ignoreInvocationExceptionsOnSetters in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignorePropertiesWithoutSetters in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownBeanProperties in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(.
ignoreUnknownBeanProperties in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownNullBeanProperties in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilderimplClass in class OutputStreamSerializerBuilderinterfaceClass - The interface class.implClass - The implementation class.public MsgPackSerializerBuilder 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 OutputStreamSerializerBuildervalues - The new value for this property.public MsgPackSerializerBuilder locale(Locale value)
BeanContextBuilderSpecifies a default locale for serializer and parser sessions.
locale in class OutputStreamSerializerBuildervalue - The new value for this property.public MsgPackSerializerBuilder mediaType(MediaType value)
BeanContextBuilderSpecifies a default media type value for serializer and parser sessions.
mediaType in class OutputStreamSerializerBuildervalue - The new value for this property.public MsgPackSerializerBuilder 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 OutputStreamSerializerBuildervalues - The values to add to this property.public MsgPackSerializerBuilder 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 OutputStreamSerializerBuildervalues - The values to add to this property.
public MsgPackSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class OutputStreamSerializerBuildervalues - The new value for this property.public MsgPackSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class OutputStreamSerializerBuildervalues - The new value for this property.
public MsgPackSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuildernotBeanClassesRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.public MsgPackSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuildernotBeanClassesRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.
public MsgPackSerializerBuilder notBeanPackages(Object... values)
BeanContextBuildernotBeanPackages in class OutputStreamSerializerBuildervalues - The values to add to this property.
public MsgPackSerializerBuilder notBeanPackages(String... values)
BeanContextBuildernotBeanPackages in class OutputStreamSerializerBuildervalues - The values to add to this property.public MsgPackSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuildernotBeanPackagesReplace in class OutputStreamSerializerBuildervalues - public MsgPackSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuildernotBeanPackagesReplace in class OutputStreamSerializerBuildervalues - public MsgPackSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuildernotBeanPackagesRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.public MsgPackSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuildernotBeanPackagesRemove in class OutputStreamSerializerBuildervalues - public MsgPackSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilderpojoSwaps in class OutputStreamSerializerBuildervalues - The values to add to this property.public MsgPackSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilderpojoSwaps in class OutputStreamSerializerBuildervalues - The values to add to this property.
PojoSwap.
SurrogateSwap.
public MsgPackSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilderpojoSwapsReplace in class OutputStreamSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public MsgPackSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilderpojoSwapsReplace in class OutputStreamSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public MsgPackSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilderpojoSwapsRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public MsgPackSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilderpojoSwapsRemove in class OutputStreamSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public MsgPackSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(.
sortProperties in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder timeZone(TimeZone value)
BeanContextBuildertimeZone in class OutputStreamSerializerBuildervalue - The new value for this property.public MsgPackSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class OutputStreamSerializerBuildervalue - The property value.public MsgPackSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler if there is no other way of instantiating them.
useInterfaceProxies in class OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder 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 OutputStreamSerializerBuildervalue - The new value for this property.
public MsgPackSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(.
useJavaBeanIntrospector in class OutputStreamSerializerBuilderpublic MsgPackSerializerBuilder set(String name, Object value)
ContextBuilderset in class OutputStreamSerializerBuildername - The property name.value - The property value.PropertyStoreBuilder.set(String, Object)public MsgPackSerializerBuilder set(Map<String,Object> properties)
ContextBuilderset in class OutputStreamSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)public MsgPackSerializerBuilder add(Map<String,Object> properties)
ContextBuilderadd in class OutputStreamSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)public MsgPackSerializerBuilder addTo(String name, Object value)
ContextBuilderaddTo in class OutputStreamSerializerBuildername - The property name.value - The new value to add to the SET property.public MsgPackSerializerBuilder addTo(String name, String key, Object value)
ContextBuilderaddTo in class OutputStreamSerializerBuildername - The property name.key - The property value map key.value - The property value map value.public MsgPackSerializerBuilder removeFrom(String name, Object value)
ContextBuilderremoveFrom in class OutputStreamSerializerBuildername - The property name.value - The property value in the SET property.public MsgPackSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilderapply in class OutputStreamSerializerBuildercopyFrom - The factory whose settings are being copied.public MsgPackSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilderapplyAnnotations in class OutputStreamSerializerBuilderal - The list of all annotations annotated with PropertyStoreApply.vrs - The string resolver for resolving variables in annotation values.public MsgPackSerializerBuilder 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 OutputStreamSerializerBuilderfromClass - The class on which the annotations are defined.public MsgPackSerializerBuilder 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 OutputStreamSerializerBuilderfromMethod - The method on which the annotations are defined.Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.