public class SerializerBuilder extends BeanTraverseBuilder
Constructor and Description |
---|
SerializerBuilder()
Constructor, default settings.
|
SerializerBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
SerializerBuilder |
add(Map<String,Object> properties)
Adds multiple free-form configuration properties on this object without first clearing out any previous values.
|
SerializerBuilder |
addBeanTypes()
|
SerializerBuilder |
addBeanTypes(boolean value)
Deprecated.
|
SerializerBuilder |
addRootType()
|
SerializerBuilder |
addRootType(boolean value)
Deprecated.
|
SerializerBuilder |
addTo(String name,
Object value)
Adds a free-form value to a SET property.
|
SerializerBuilder |
annotations(Annotation... values)
|
SerializerBuilder |
appendTo(String name,
Object value)
Adds a free-form value to the end of a LIST property.
|
SerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
SerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession r)
Applies a set of annotations to this property store.
|
SerializerBuilder |
applyAnnotations(Class<?>... fromClasses)
Applies any of the various
|
SerializerBuilder |
applyAnnotations(Method... fromMethods)
Applies any of the various
|
SerializerBuilder |
beanClassVisibility(Visibility value)
|
SerializerBuilder |
beanConstructorVisibility(Visibility value)
|
SerializerBuilder |
beanFieldVisibility(Visibility value)
|
SerializerBuilder |
beanInterceptor(Class<?> on,
Class<? extends BeanInterceptor<?>> value)
Bean interceptor.
|
SerializerBuilder |
beanMapPutReturnsOldValue()
|
SerializerBuilder |
beanMethodVisibility(Visibility value)
|
SerializerBuilder |
beansDontRequireSomeProperties()
|
SerializerBuilder |
beansRequireDefaultConstructor()
|
SerializerBuilder |
beansRequireSerializable()
|
SerializerBuilder |
beansRequireSettersForGetters()
|
SerializerBuilder |
bpi(Class<?> beanClass,
String properties)
Bean property includes.
|
SerializerBuilder |
bpi(Map<String,Object> values)
Bean property includes.
|
SerializerBuilder |
bpi(String beanClassName,
String properties)
Bean property includes.
|
SerializerBuilder |
bpro(Class<?> beanClass,
String properties)
Read-only bean properties.
|
SerializerBuilder |
bpro(Map<String,Object> values)
Read-only bean properties.
|
SerializerBuilder |
bpro(String beanClassName,
String properties)
Read-only bean properties.
|
SerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Write-only bean properties.
|
SerializerBuilder |
bpwo(Map<String,Object> values)
Write-only bean properties.
|
SerializerBuilder |
bpwo(String beanClassName,
String properties)
Write-only bean properties.
|
SerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Bean property excludes.
|
SerializerBuilder |
bpx(Map<String,Object> values)
Bean property excludes.
|
SerializerBuilder |
bpx(String beanClassName,
String properties)
Bean property excludes.
|
Serializer |
build()
Build the object.
|
SerializerBuilder |
debug()
|
SerializerBuilder |
detectRecursions()
|
SerializerBuilder |
dictionary(Object... values)
|
SerializerBuilder |
dictionaryOn(Class<?> on,
Class<?>... values)
|
SerializerBuilder |
dontIgnorePropertiesWithoutSetters()
|
SerializerBuilder |
dontIgnoreTransientFields()
|
SerializerBuilder |
dontIgnoreUnknownNullBeanProperties()
|
SerializerBuilder |
dontTrimNullProperties()
Deprecated.
|
SerializerBuilder |
dontUseInterfaceProxies()
|
<T> SerializerBuilder |
example(Class<T> pojoClass,
T o)
|
<T> SerializerBuilder |
exampleJson(Class<T> pojoClass,
String json)
|
SerializerBuilder |
fluentSetters()
|
SerializerBuilder |
fluentSetters(Class<?> on)
|
SerializerBuilder |
ignoreInvocationExceptionsOnGetters()
|
SerializerBuilder |
ignoreInvocationExceptionsOnSetters()
|
SerializerBuilder |
ignoreRecursions()
|
SerializerBuilder |
ignoreUnknownBeanProperties()
|
SerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
|
SerializerBuilder |
implClasses(Map<Class<?>,Class<?>> values)
|
SerializerBuilder |
initialDepth(int value)
|
SerializerBuilder |
interfaceClass(Class<?> on,
Class<?> value)
Identifies a class to be used as the interface class for the specified class and all subclasses.
|
SerializerBuilder |
interfaces(Class<?>... value)
Identifies a set of interfaces.
|
SerializerBuilder |
keepNullProperties()
|
SerializerBuilder |
keepNullProperties(boolean value)
Deprecated.
|
SerializerBuilder |
listener(Class<? extends SerializerListener> value)
|
SerializerBuilder |
locale(Locale value)
|
SerializerBuilder |
maxDepth(int value)
|
SerializerBuilder |
mediaType(MediaType value)
|
SerializerBuilder |
notBeanClasses(Object... values)
|
SerializerBuilder |
notBeanPackages(Object... values)
|
SerializerBuilder |
prependTo(String name,
Object value)
Adds a free-form value to the beginning of a LIST property.
|
SerializerBuilder |
propertyNamer(Class<?> on,
Class<? extends PropertyNamer> value)
Bean property namer
|
SerializerBuilder |
propertyNamer(Class<? extends PropertyNamer> value)
|
SerializerBuilder |
putAllTo(String name,
Object value)
Adds or overwrites multiple free-form entries in a MAP property.
|
SerializerBuilder |
putTo(String name,
String key,
Object value)
Adds or overwrites a free-form entry in a MAP property.
|
SerializerBuilder |
removeFrom(String name,
Object value)
Removes a free-form value from a SET, LIST, or MAP property.
|
SerializerBuilder |
set(Map<String,Object> properties)
Sets multiple free-form configuration properties on this object replacing all previous values.
|
SerializerBuilder |
set(String name,
Object value)
Sets a free-form configuration property on this object.
|
SerializerBuilder |
sortCollections()
|
SerializerBuilder |
sortCollections(boolean value)
Deprecated.
|
SerializerBuilder |
sortMaps()
|
SerializerBuilder |
sortMaps(boolean value)
Deprecated.
|
SerializerBuilder |
sortProperties()
|
SerializerBuilder |
sortProperties(Class<?>... on)
Sort bean properties.
|
SerializerBuilder |
stopClass(Class<?> on,
Class<?> value)
Identifies a stop class for the annotated class.
|
SerializerBuilder |
swaps(Object... values)
|
SerializerBuilder |
timeZone(TimeZone value)
|
SerializerBuilder |
trimEmptyCollections()
|
SerializerBuilder |
trimEmptyCollections(boolean value)
Deprecated.
|
SerializerBuilder |
trimEmptyMaps()
|
SerializerBuilder |
trimEmptyMaps(boolean value)
Deprecated.
|
SerializerBuilder |
trimNullProperties(boolean value)
Deprecated.
|
SerializerBuilder |
trimStrings()
|
SerializerBuilder |
trimStrings(boolean value)
Deprecated.
|
SerializerBuilder |
typeName(Class<?> on,
String value)
An identifying name for this class.
|
SerializerBuilder |
typePropertyName(Class<?> on,
String value)
|
SerializerBuilder |
typePropertyName(String value)
|
SerializerBuilder |
uriContext(UriContext value)
|
SerializerBuilder |
uriRelativity(UriRelativity value)
|
SerializerBuilder |
uriResolution(UriResolution value)
|
SerializerBuilder |
useEnumNames()
|
SerializerBuilder |
useJavaBeanIntrospector()
|
detectRecursions, ignoreRecursions
beanDictionary, beanDictionary, beanDictionaryRemove, beanDictionaryRemove, beanDictionaryReplace, beanDictionaryReplace, beanFilters, beanFiltersRemove, beanFiltersReplace, beanMapPutReturnsOldValue, beansRequireDefaultConstructor, beansRequireSerializable, beansRequireSettersForGetters, beansRequireSomeProperties, debug, excludeProperties, excludeProperties, excludeProperties, fluentSetters, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnSetters, ignorePropertiesWithoutSetters, ignoreTransientFields, ignoreUnknownBeanProperties, ignoreUnknownNullBeanProperties, includeProperties, includeProperties, includeProperties, pojoSwaps, pojoSwapsRemove, pojoSwapsReplace, sortProperties, useEnumNames, useInterfaceProxies, useJavaBeanIntrospector
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public SerializerBuilder()
public SerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.@Deprecated public SerializerBuilder addBeanTypes(boolean value)
addBeanTypes()
public SerializerBuilder addBeanTypes()
When enabled,
This is used to recreate the correct objects during parsing if the object types cannot be inferred.
For example, when serializing a
Note the differences between the following settings:
addRootType()
- Affects whether addBeanTypes()
- Affects whether
@Deprecated public SerializerBuilder addRootType(boolean value)
addRootType()
public SerializerBuilder addRootType()
When enabled,
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.
For example, when serializing a top-level POJO with a @Bean(typeName)
value, a
Note the differences between the following settings:
addRootType()
- Affects whether addBeanTypes()
- Affects whether
@Deprecated public SerializerBuilder keepNullProperties(boolean value)
keepNullProperties()
public SerializerBuilder keepNullProperties()
When enabled, null bean values will be serialized to the output.
public SerializerBuilder listener(Class<? extends SerializerListener> value)
Class used to listen for errors and warnings that occur during serialization.
value
- The new value for this property.@Deprecated public SerializerBuilder sortCollections(boolean value)
sortCollections()
public SerializerBuilder sortCollections()
When enabled, copies and sorts the contents of arrays and collections before serializing them.
Note that this introduces a performance penalty since it requires copying the existing collection.
@Deprecated public SerializerBuilder sortMaps(boolean value)
sortMaps()
public SerializerBuilder sortMaps()
When enabled, copies and sorts the contents of maps by their keys before serializing them.
Note that this introduces a performance penalty.
@Deprecated public SerializerBuilder trimEmptyCollections(boolean value)
trimEmptyCollections()
public SerializerBuilder trimEmptyCollections()
When enabled, empty lists and arrays will not be serialized.
Note that enabling this setting has the following effects on parsing:
@Deprecated public SerializerBuilder trimEmptyMaps(boolean value)
trimEmptyMaps()
public SerializerBuilder trimEmptyMaps()
When enabled, empty map values will not be serialized to the output.
Note that enabling this setting has the following effects on parsing:
@Deprecated public SerializerBuilder trimNullProperties(boolean value)
keepNullProperties()
@Deprecated public SerializerBuilder dontTrimNullProperties()
keepNullProperties()
@Deprecated public SerializerBuilder trimStrings(boolean value)
trimStrings()
public SerializerBuilder trimStrings()
When enabled, string values will be trimmed of whitespace using String.trim()
before being serialized.
public SerializerBuilder uriContext(UriContext value)
Bean used for resolution of URIs to absolute or root-relative form.
value
- The new value for this property.public SerializerBuilder uriRelativity(UriRelativity value)
Defines what relative URIs are relative to when serializing any of the following:
Possible values are:
UriRelativity.RESOURCE
- Relative URIs should be considered relative to the servlet URI.
UriRelativity.PATH_INFO
- Relative URIs should be considered relative to the request URI.
See uriContext(UriContext)
for examples.
value
- The new value for this property.
UriRelativity.RESOURCE
public SerializerBuilder uriResolution(UriResolution value)
Defines the resolution level for URIs when serializing any of the following:
Possible values are:
UriResolution.ABSOLUTE
- Resolve to an absolute URL (e.g. UriResolution.ROOT_RELATIVE
- Resolve to a root-relative URL (e.g. UriResolution.NONE
- Don't do any URL resolution.
See uriContext(UriContext)
for examples.
value
- The new value for this property.
UriResolution.NONE
public SerializerBuilder add(Map<String,Object> properties)
ContextBuilder
Identical in function to ContextBuilder.set(String, Object)
but allows you to specify multiple values at once.
add
in class BeanTraverseBuilder
properties
- The properties to set on this class.
public SerializerBuilder addTo(String name, Object value)
ContextBuilder
SET properties are those properties with one of the following type parts:
For example, the BeanContext.BEAN_notBeanClasses
property which has the value
addTo
in class BeanTraverseBuilder
name
- The property name.value
- The new value to add to the SET property.
public SerializerBuilder appendTo(String name, Object value)
ContextBuilder
LIST properties are those properties with one of the following type parts:
For example, the BeanContext.BEAN_swaps
property which has the value
appendTo
in class BeanTraverseBuilder
name
- The property name.value
- The new value to add to the LIST property.
public SerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class BeanTraverseBuilder
copyFrom
- The property store whose settings are being copied.public SerializerBuilder applyAnnotations(Class<?>... fromClasses)
ContextBuilder
Any annotations found that themselves are annotated with PropertyStoreApply
will be resolved and
applied as properties to this builder. These annotations include:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations on classes are appended in the following order:
The default var resolver VarResolver.DEFAULT
is used to resolve any variables in annotation field values.
applyAnnotations
in class BeanTraverseBuilder
fromClasses
- The classes on which the annotations are defined.public SerializerBuilder applyAnnotations(Method... fromMethods)
ContextBuilder
Any annotations found that themselves are annotated with PropertyStoreApply
will be resolved and
applied as properties to this builder. These annotations include:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations on methods are appended in the following order:
The default var resolver VarResolver.DEFAULT
is used to resolve any variables in annotation field values.
applyAnnotations
in class BeanTraverseBuilder
fromMethods
- The methods on which the annotations are defined.public SerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession r)
ContextBuilder
The AnnotationList
object is an ordered list of annotations and the classes/methods/packages they were found on.
applyAnnotations
in class BeanTraverseBuilder
al
- The list of all annotations annotated with PropertyStoreApply
.r
- The string resolver for resolving variables in annotation values.public SerializerBuilder debug()
ContextBuilder
Enables the following additional information during serialization:
BeanTraverseContext.BEANTRAVERSE_detectRecursions
.
Enables the following additional information during parsing:
debug
in class BeanTraverseBuilder
public SerializerBuilder locale(Locale value)
ContextBuilder
Specifies the default locale for serializer and parser sessions when not specified via SessionArgs.locale(Locale)
.
Typically used for POJO swaps that need to deal with locales such as swaps that convert PojoSwap.swap(BeanSession, Object)
and
PojoSwap.unswap(BeanSession, Object, ClassMeta, String)
methods.
locale
in class BeanTraverseBuilder
value
- The new value for this property.public SerializerBuilder mediaType(MediaType value)
ContextBuilder
Specifies the default media type for serializer and parser sessions when not specified via SessionArgs.mediaType(MediaType)
.
Typically used for POJO swaps that need to serialize the same POJO classes differently depending on
the specific requested media type. For example, a swap could handle a request for media types
mediaType
in class BeanTraverseBuilder
value
- The new value for this property.public SerializerBuilder prependTo(String name, Object value)
ContextBuilder
LIST properties are those properties with one of the following type parts:
For example, the BeanContext.BEAN_swaps
property which has the value
prependTo
in class BeanTraverseBuilder
name
- The property name.value
- The new value to add to the LIST property.
public SerializerBuilder putAllTo(String name, Object value)
ContextBuilder
MAP properties are those properties with one of the following type parts:
For example, the BeanContext.BEAN_implClasses
property which has the value
putAllTo
in class BeanTraverseBuilder
name
- The property name.value
- Either a JSON Object string or a Map
whose valid value types depend on the property type:
public SerializerBuilder putTo(String name, String key, Object value)
ContextBuilder
MAP properties are those properties with one of the following type parts:
For example, the BeanContext.BEAN_implClasses
property which has the value
putTo
in class BeanTraverseBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.
public SerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class BeanTraverseBuilder
name
- The property name.value
- The property value in the SET/LIST/MAP property.public SerializerBuilder set(Map<String,Object> properties)
ContextBuilder
Identical in function to ContextBuilder.set(String, Object)
but allows you to specify multiple values at once.
set
in class BeanTraverseBuilder
properties
- The properties to set on this class.
public SerializerBuilder set(String name, Object value)
ContextBuilder
Provides the ability to specify configuration property values in a generic fashion.
Property names must have the following format that identify their datatype...
...where the parts consist of the following...
For example,
Property values get 'normalized' when they get set.
For example, calling PropertyStore
class to be comparable
and useful in determining whether a cached instance of a context object can be returned.
As a general rule, builders don't typically have "unsetter" methods. For example, once you've set strict
mode on the
set
in class BeanTraverseBuilder
name
- The property name.value
- The property value.
public SerializerBuilder timeZone(TimeZone value)
ContextBuilder
Specifies the default time zone for serializer and parser sessions when not specified via SessionArgs.timeZone(TimeZone)
.
Typically used for POJO swaps that need to deal with timezones such as swaps that convert PojoSwap.swap(BeanSession, Object)
and
PojoSwap.unswap(BeanSession, Object, ClassMeta, String)
methods.
timeZone
in class BeanTraverseBuilder
value
- The new value for this property.public SerializerBuilder annotations(Annotation... values)
BeanContextBuilder
Defines annotations to apply to specific classes and methods.
Allows you to dynamically apply Juneau annotations typically applied directly to classes and methods. Useful in cases where you want to use the functionality of the annotation on beans and bean properties but do not have access to the code to do so.
As a rule, any Juneau annotation with an
The following example shows the equivalent methods for applying the @Bean
annotation:
In general, the underlying framework uses this method when it finds dynamically applied annotations on config annotations. However, concrete implementations of annotations are also provided that can be passed directly into builder classes like so:
The following is the list of concrete annotations provided that can be constructed and passed into the builder class:
BeanAnnotation
BeancAnnotation
BeanIgnoreAnnotation
BeanpAnnotation
ExampleAnnotation
NamePropertyAnnotation
ParentPropertyAnnotation
SwapAnnotation
UriAnnotation
CsvAnnotation
HtmlAnnotation
JsoAnnotation
JsonAnnotation
SchemaAnnotation
MsgPackAnnotation
OpenApiAnnotation
PlainTextAnnotation
SoapXmlAnnotation
UonAnnotation
UrlEncodingAnnotation
XmlAnnotation
The syntax for the
annotations
in class BeanTraverseBuilder
values
- The values to add to this property.public SerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilder
Classes are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
@Bean
annotation can be used on a non-public bean class to override this setting.
@BeanIgnore
annotation can also be used on a public bean class to ignore it as a bean.
beanClassVisibility
in class BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public SerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
This setting affects the logic for finding no-arg constructors for bean. Normally, only
@Beanc
annotation can also be used to expose a non-public constructor.
@BeanIgnore
annotation can also be used on a public bean constructor to ignore it.
beanConstructorVisibility
in class BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public SerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
This affects which fields on a bean class are considered bean properties. Normally only
Bean fields can be ignored as properties entirely by setting the value to Visibility.NONE
@Beanp
annotation can also be used to expose a non-public field.
@BeanIgnore
annotation can also be used on a public bean field to ignore it as a bean property.
beanFieldVisibility
in class BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public SerializerBuilder beanInterceptor(Class<?> on, Class<? extends BeanInterceptor<?>> value)
BeanContextBuilder
Bean interceptors can be used to intercept calls to getters and setters and alter their values in transit.
beanInterceptor
in class BeanTraverseBuilder
on
- The bean that the filter applies to.value
- The new value for this property.public SerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
When enabled, then the BeanMap.put()
method will return old property
values. Otherwise, it returns
Disabled by default because it introduces a slight performance penalty during serialization.
beanMapPutReturnsOldValue
in class BeanTraverseBuilder
public SerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
This affects which methods are detected as getters and setters on a bean class. Normally only
@Beanp
annotation can also be used to expose a non-public method.
@BeanIgnore
annotation can also be used on a public bean getter/setter to ignore it as a bean property.
beanMethodVisibility
in class BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
public SerializerBuilder beansDontRequireSomeProperties()
BeanContextBuilder
When enabled, then a Java class must contain at least 1 property to be considered a bean.
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
The @Bean
annotation can be used on a class to override this setting when
@Bean
annotation can be used on the class to force it to be recognized as a bean class
even if it has no properties.
beansDontRequireSomeProperties
in class BeanTraverseBuilder
public SerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
When enabled, a Java class must implement a default no-arg constructor to be considered a bean.
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
@Bean
annotation can be used on a bean class to override this setting.
@BeanIgnore
annotation can also be used on a class to ignore it as a bean.
beansRequireDefaultConstructor
in class BeanTraverseBuilder
public SerializerBuilder beansRequireSerializable()
BeanContextBuilder
When enabled, a Java class must implement the Serializable
interface to be considered a bean.
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
@Bean
annotation can be used on a bean class to override this setting.
@BeanIgnore
annotation can also be used on a class to ignore it as a bean.
beansRequireSerializable
in class BeanTraverseBuilder
public SerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
When enabled, ignore read-only properties (properties with getters but not setters).
@Beanp
annotation can be used on the getter to override this setting.
@BeanIgnore
annotation can also be used on getters to ignore them as bean properties.
beansRequireSettersForGetters
in class BeanTraverseBuilder
public SerializerBuilder bpi(Map<String,Object> values)
BeanContextBuilder
Specifies the set and order of names of properties associated with bean classes.
For example, BeanContextBuilder.ignoreUnknownBeanProperties()
has been called.
This value is entirely optional if you simply want to expose all the getters and public fields on a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code, whereas on Oracle JREs, the order is entirely random.
Setting applies to specified class and all subclasses.
This method is functionally equivalent to the following code for each entry:
builder.annotations(
Bean.bpi()
- On an annotation on the bean class itself.
BeanConfig.bpi()
- On a bean config annotation (see BeanContextBuilder.annotations(Annotation...)
).
bpi
in class BeanTraverseBuilder
values
- The values to add to this builder.
public SerializerBuilder bpi(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
For example, BeanContextBuilder.ignoreUnknownBeanProperties()
has been called.
This value is entirely optional if you simply want to expose all the getters and public fields on a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code, whereas on Oracle JREs, the order is entirely random.
Setting applies to specified class and all subclasses.
This method is functionally equivalent to the following code:
builder.annotations(
Bean.bpi()
- On an annotation on the bean class itself.
BeanConfig.bpi()
- On a bean config annotation (see BeanContextBuilder.annotations(Annotation...)
).
bpi
in class BeanTraverseBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public SerializerBuilder bpi(String beanClassName, String properties)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
For example, BeanContextBuilder.ignoreUnknownBeanProperties()
has been called.
This value is entirely optional if you simply want to expose all the getters and public fields on a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code, whereas on Oracle JREs, the order is entirely random.
Setting applies to specified class and all subclasses.
This method is functionally equivalent to the following code:
builder.annotations(
Bean.bpi()
- On an annotation on the bean class itself.
BeanConfig.bpi()
- On a bean config annotation (see BeanContextBuilder.annotations(Annotation...)
).
bpi
in class BeanTraverseBuilder
beanClassName
- The bean class name.
properties
- Comma-delimited list of property names.public SerializerBuilder bpro(Map<String,Object> values)
BeanContextBuilder
Specifies one or more properties on beans that are read-only despite having valid getters.
Serializers will serialize such properties as usual, but parsers will silently ignore them.
Note that this is different from the
This method is functionally equivalent to the following code for each entry:
builder.annotations(
bpro
in class BeanTraverseBuilder
values
- The values to add to this builder.
public SerializerBuilder bpro(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies one or more properties on a bean that are read-only despite having valid getters.
Serializers will serialize such properties as usual, but parsers will silently ignore them.
Note that this is different from the
This method is functionally equivalent to the following code:
builder.annotations(
bpro
in class BeanTraverseBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public SerializerBuilder bpro(String beanClassName, String properties)
BeanContextBuilder
Specifies one or more properties on a bean that are read-only despite having valid getters.
Serializers will serialize such properties as usual, but parsers will silently ignore them.
Note that this is different from the
This method is functionally equivalent to the following code:
builder.annotations(
bpro
in class BeanTraverseBuilder
beanClassName
- The bean class name.
properties
- Comma-delimited list of property names.public SerializerBuilder bpwo(Map<String,Object> values)
BeanContextBuilder
Specifies one or more properties on a bean that are write-only despite having valid setters.
Parsers will parse such properties as usual, but serializers will silently ignore them.
Note that this is different from the
This method is functionally equivalent to the following code for each entry:
builder.annotations(
bpwo
in class BeanTraverseBuilder
values
- The values to add to this builder.
public SerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies one or more properties on a bean that are write-only despite having valid setters.
Parsers will parse such properties as usual, but serializers will silently ignore them.
Note that this is different from the
This method is functionally equivalent to the following code:
builder.annotations(
bpwo
in class BeanTraverseBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public SerializerBuilder bpwo(String beanClassName, String properties)
BeanContextBuilder
Specifies one or more properties on a bean that are write-only despite having valid setters.
Parsers will parse such properties as usual, but serializers will silently ignore them.
Note that this is different from the
This method is functionally equivalent to the following code:
builder.annotations(
bpwo
in class BeanTraverseBuilder
beanClassName
- The bean class name.
properties
- Comma-delimited list of property names.public SerializerBuilder bpx(Map<String,Object> values)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean classes.
Same as BeanContextBuilder.bpi(Map)
except you specify a list of bean property names that you want to exclude from
serialization.
Setting applies to specified class and all subclasses.
This method is functionally equivalent to the following code for each entry:
builder.annotations(
bpx
in class BeanTraverseBuilder
values
- The values to add to this builder.
public SerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean class.
Same as BeanContextBuilder.bpi(Class, String)
except you specify a list of bean property names that you want to exclude from
serialization.
Setting applies to specified class and all subclasses.
This method is functionally equivalent to the following code:
builder.annotations(
bpx
in class BeanTraverseBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public SerializerBuilder bpx(String beanClassName, String properties)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean class.
Same as BeanContextBuilder.bpx(String, String)
except you specify a list of bean property names that you want to exclude from
serialization.
Setting applies to specified class and all subclasses.
This method is functionally equivalent to the following code:
builder.annotations(
bpx
in class BeanTraverseBuilder
beanClassName
- The bean class name.
properties
- Comma-delimited list of property names.public SerializerBuilder dictionary(Object... values)
BeanContextBuilder
The list of classes that make up the bean dictionary in this bean context.
A dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred
through reflection. The names are defined through the @Bean(typeName)
annotation defined
on the bean class. For example, if a class
This setting tells the parsers which classes to look for when resolving
Values can consist of any of the following types:
@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.
Another option is to use the Bean.dictionary()
annotation on the POJO class itself:
A typical usage is to allow for HTML documents to be parsed back into HTML beans:
dictionary
in class BeanTraverseBuilder
values
- The values to add to this property.public SerializerBuilder dictionaryOn(Class<?> on, Class<?>... values)
BeanContextBuilder
This is identical to BeanContextBuilder.dictionary(Object...)
, but specifies a dictionary within the context of
a single class as opposed to globally.
This is functionally equivalent to the Bean.dictionary()
annotation.
dictionaryOn
in class BeanTraverseBuilder
on
- The class that the dictionary values apply to.values
- The new values for this property.public SerializerBuilder dontIgnorePropertiesWithoutSetters()
BeanContextBuilder
When enabled, trying to set a value on a bean property without a setter will silently be ignored.
Otherwise, a BeanRuntimeException
is thrown.
@BeanIgnore
annotation can also be used on getters and fields to ignore them.
dontIgnorePropertiesWithoutSetters
in class BeanTraverseBuilder
public SerializerBuilder dontIgnoreTransientFields()
BeanContextBuilder
When enabled, methods and fields marked as
@Beanp
annotation can also be used on transient fields to keep them from being ignored.
dontIgnoreTransientFields
in class BeanTraverseBuilder
public SerializerBuilder dontIgnoreUnknownNullBeanProperties()
BeanContextBuilder
When enabled, trying to set a BeanRuntimeException
is thrown.
dontIgnoreUnknownNullBeanProperties
in class BeanTraverseBuilder
public SerializerBuilder dontUseInterfaceProxies()
BeanContextBuilder
When enabled, interfaces will be instantiated as proxy classes through the use of an
InvocationHandler
if there is no other way of instantiating them.
Otherwise, throws a BeanRuntimeException
.
dontUseInterfaceProxies
in class BeanTraverseBuilder
public <T> SerializerBuilder example(Class<T> pojoClass, T o)
BeanContextBuilder
Specifies an example of the specified class.
Examples are used in cases such as POJO examples in Swagger documents.
Setting applies to specified class and all subclasses.
POJO examples can also be defined on classes via the following:
@Example
.
@Example
with zero arguments or one BeanSession
argument.
BeanSession
argument.
example
in class BeanTraverseBuilder
pojoClass
- The POJO class.o
- An instance of the POJO class used for examples.public <T> SerializerBuilder exampleJson(Class<T> pojoClass, String json)
BeanContextBuilder
Specifies an example in JSON of the specified class.
Examples are used in cases such as POJO examples in Swagger documents.
Setting applies to specified class and all subclasses.
POJO examples can also be defined on classes via the following:
@Example
.
@Example
with zero arguments or one BeanSession
argument.
BeanSession
argument.
exampleJson
in class BeanTraverseBuilder
T
- The POJO class type.pojoClass
- The POJO class.json
- The simple JSON representation of the example.public SerializerBuilder fluentSetters()
BeanContextBuilder
When enabled, fluent setters are detected on beans during parsing.
Fluent setters must have the following attributes:
@Beanp
annotation can also be used on methods to individually identify them as fluent setters.
@Bean.fluentSetters()
annotation can also be used on classes to specify to look for fluent setters.
fluentSetters
in class BeanTraverseBuilder
public SerializerBuilder fluentSetters(Class<?> on)
BeanContextBuilder
Identical to BeanContextBuilder.fluentSetters()
but enables it on a specific class only.
Bean.fluentSetters()
annotation.
fluentSetters
in class BeanTraverseBuilder
on
- The class that this applies to.public SerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
When enabled, errors thrown when calling bean getter methods will silently be ignored.
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class BeanTraverseBuilder
public SerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
When enabled, errors thrown when calling bean setter methods will silently be ignored.
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class BeanTraverseBuilder
public SerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
When enabled, trying to set a value on a non-existent bean property will silently be ignored.
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class BeanTraverseBuilder
public SerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
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).
implClass
in class BeanTraverseBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public SerializerBuilder implClasses(Map<Class<?>,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 BeanTraverseBuilder
values
- The new value for this property.public SerializerBuilder interfaceClass(Class<?> on, Class<?> value)
BeanContextBuilder
When specified, only the list of properties defined on the interface class will be used during serialization. Additional properties on subclasses will be ignored.
This annotation can be used on the parent class so that it filters to all child classes, or can be set individually on the child classes.
@Bean(interfaceClass)
annotation is the equivalent annotation-based solution.
interfaceClass
in class BeanTraverseBuilder
on
- The class that the interface class applies to.value
- The new value for this property.public SerializerBuilder interfaces(Class<?>... value)
BeanContextBuilder
When specified, only the list of properties defined on the interface class will be used during serialization of implementation classes. Additional properties on subclasses will be ignored.
This annotation can be used on the parent class so that it filters to all child classes, or can be set individually on the child classes.
@Bean(interfaceClass)
annotation is the equivalent annotation-based solution.
interfaces
in class BeanTraverseBuilder
value
- The new value for this property.public SerializerBuilder 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
Values can consist of any of the following types:
@BeanIgnore
annotation can also be used on classes to prevent them from being recognized as beans.
notBeanClasses
in class BeanTraverseBuilder
values
- The values to add to this property.
public SerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
Used as a convenient way of defining the BeanContextBuilder.notBeanClasses(Object...)
property for entire packages.
Any classes within these packages will be serialized to strings using Object.toString()
.
Note that you can specify suffix patterns to include all subpackages.
Values can consist of any of the following types:
notBeanPackages
in class BeanTraverseBuilder
values
- The values to add to this property.
Package
objects.
public SerializerBuilder propertyNamer(Class<? extends PropertyNamer> value)
BeanContextBuilder
The class to use for calculating bean property names.
Predefined classes:
PropertyNamerDefault
- Default.
PropertyNamerDLC
- Dashed-lower-case names.
PropertyNamerULC
- Dashed-upper-case names.
propertyNamer
in class BeanTraverseBuilder
value
- The new value for this setting.
PropertyNamerDefault
.public SerializerBuilder propertyNamer(Class<?> on, Class<? extends PropertyNamer> value)
BeanContextBuilder
Same as BeanContextBuilder.propertyNamer(Class)
but allows you to specify a namer for a specific class.
propertyNamer
in class BeanTraverseBuilder
on
- The class that the namer applies to.value
- The new value for this setting.
PropertyNamerDefault
.public SerializerBuilder sortProperties()
BeanContextBuilder
When enabled, all bean properties will be serialized and access in alphabetical order. Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor. On IBM JVMs, the bean properties are ordered based on their ordering in the Java file. On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
This property is disabled by default so that IBM JVM users don't have to use @Bean
annotations
to force bean properties to be in a particular order and can just alter the order of the fields/methods
in the Java file.
@Bean.sort()
annotation can also be used to sort properties on just a single class.
sortProperties
in class BeanTraverseBuilder
public SerializerBuilder sortProperties(Class<?>... on)
BeanContextBuilder
Same as BeanContextBuilder.sortProperties()
but allows you to specify individual bean classes instead of globally.
sortProperties
in class BeanTraverseBuilder
on
- The bean classes to sort properties on.public SerializerBuilder stopClass(Class<?> on, Class<?> value)
BeanContextBuilder
Identical in purpose to the stop class specified by Introspector.getBeanInfo(Class, Class)
.
Any properties in the stop class or in its base classes will be ignored during analysis.
For example, in the following class hierarchy, instances of
stopClass
in class BeanTraverseBuilder
on
- The class on which the stop class is being applied.value
- The new value for this property.public SerializerBuilder swaps(Object... values)
BeanContextBuilder
Swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization, and "swap in" the non-serializable class during parsing.
An example of a swap would be a
Multiple swaps can be associated with a single class.
When multiple swaps are applicable to the same class, the media type pattern defined by
PojoSwap.forMediaTypes()
or @Swap(mediaTypes)
are used to come up with the best match.
Values can consist of any of the following types:
PojoSwap
.
PojoSwap
.
SurrogateSwap
.
swaps
in class BeanTraverseBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public SerializerBuilder typeName(Class<?> on, String value)
BeanContextBuilder
The name is used to identify the class type during parsing when it cannot be inferred through reflection.
For example, if a bean property is of type
It is also used to specify element names in XML.
Bean(typeName)
annotation.
typeName
in class BeanTraverseBuilder
on
- The class the type name is being defined on.value
- The new value for this property.public SerializerBuilder typePropertyName(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.
typePropertyName
in class BeanTraverseBuilder
value
- The new value for this property.
public SerializerBuilder typePropertyName(Class<?> on, String value)
BeanContextBuilder
Same as BeanContextBuilder.typePropertyName(String)
except targets a specific bean class instead of globally.
typePropertyName
in class BeanTraverseBuilder
on
- The class the type property name applies to.value
- The new value for this property.
public SerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name, not using Object.toString()
.
useEnumNames
in class BeanTraverseBuilder
public SerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
Most @Bean
annotations will be ignored.
useJavaBeanIntrospector
in class BeanTraverseBuilder
public SerializerBuilder detectRecursions()
BeanTraverseBuilder
When enabled, specifies that recursions should be checked for during traversal.
Recursions can occur when traversing models that aren't true trees but rather contain loops.
In general, unchecked recursions cause stack-overflow-errors.
These show up as BeanRecursionException
with the message
detectRecursions
in class BeanTraverseBuilder
public SerializerBuilder ignoreRecursions()
BeanTraverseBuilder
When enabled, when we encounter the same object when traversing a tree, we set the value to
For example, if a model contains the links A->B->C->A, then the JSON generated will look like
the following when
{A:{B:{C:
ignoreRecursions
in class BeanTraverseBuilder
public SerializerBuilder initialDepth(int value)
BeanTraverseBuilder
The initial indentation level at the root.
Useful when constructing document fragments that need to be indented at a certain level when whitespace is enabled.
initialDepth
in class BeanTraverseBuilder
value
- The new value for this property.
public SerializerBuilder maxDepth(int value)
BeanTraverseBuilder
When enabled, 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 BeanTraverseBuilder
value
- The new value for this property.
public Serializer build()
ContextBuilder
build
in class BeanTraverseBuilder
Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.