Package org.apache.juneau.annotation

Annotation Type BeanConfig

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@ContextApply(Applier.class)
public @interface BeanConfig

Annotation for specifying config properties defined in BeanContext and BeanTraverseContext.

Used primarily for specifying bean configuration properties on REST classes and methods.

See Also:

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	beanClassVisibility	Minimum bean class visibility.
String	beanConstructorVisibility	Minimum bean constructor visibility.
String	beanFieldVisibility	Minimum bean field visibility.
String	beanMapPutReturnsOldValue	BeanMap.put() returns old property value.
String	beanMethodVisibility	Minimum bean method visibility.
String	beansRequireDefaultConstructor	Beans require no-arg constructors.
String	beansRequireSerializable	Beans require Serializable interface.
String	beansRequireSettersForGetters	Beans require setters for getters.
String	debug	Debug mode.
Class<?>[]	dictionary	Bean dictionary.
Class<?>[]	dictionary_replace	Replace bean dictionary.
String	disableBeansRequireSomeProperties	Beans don't require at least one property.
String	disableIgnoreMissingSetters	Don't silently ignore missing setters.
String	disableIgnoreTransientFields	Don't ignore transient fields.
String	disableIgnoreUnknownNullBeanProperties	Don't ignore unknown properties with null values.
String	disableInterfaceProxies	Don't use interface proxies.
String	findFluentSetters	Find fluent setters.
String	ignoreInvocationExceptionsOnGetters	Ignore invocation errors on getters.
String	ignoreInvocationExceptionsOnSetters	Ignore invocation errors on setters.
String	ignoreUnknownBeanProperties	Ignore unknown properties.
String	ignoreUnknownEnumValues	Ignore unknown enum values.
Class<?>[]	interfaces	Identifies a set of interfaces.
String	locale	Locale.
String	mediaType	Media type.
Class<?>[]	notBeanClasses	Bean class exclusions.
Class<?>[]	notBeanClasses_replace	Replace classes that should not be considered beans.
String[]	notBeanPackages	Bean package exclusions.
String[]	notBeanPackages_replace	Replace packages whose classes should not be considered beans.
Class<? extends PropertyNamer>	propertyNamer	Bean property namer.
int	rank	Optional rank for this config.
String	sortProperties	Sort bean properties.
Class<?>[]	swaps	Java object swaps.
Class<?>[]	swaps_replace	Replace Java object swap classes.
String	timeZone	Time zone.
String	typePropertyName	Bean type property name.
String	useEnumNames	Use enum names.
String	useJavaBeanIntrospector	Use Java Introspector.

Element Details

rank

int rank

Optional rank for this config.

Can be used to override default ordering and application of config annotations.

Returns:

The annotation value.

Default:

0

beanClassVisibility

String beanClassVisibility

Minimum bean class visibility.

Classes are not considered beans unless they meet the minimum visibility requirements.

For example, if the visibility is PUBLIC and the bean class is protected, then the class will not be interpreted as a bean class and be serialized as a string.
Use this setting to reduce the visibility requirement.

• "PUBLIC" (default)
• "PROTECTED"
• "DEFAULT"
• "PRIVATE"

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.beanClassVisibility(Visibility)

Returns:

The annotation value.

Default:

""

beanConstructorVisibility

String beanConstructorVisibility

Minimum bean constructor visibility.

Only look for constructors with the specified minimum visibility.

This setting affects the logic for finding no-arg constructors for bean.
Normally, only public no-arg constructors are used.
Use this setting if you want to reduce the visibility requirement.

• "PUBLIC" (default)
• "PROTECTED"
• "DEFAULT"
• "PRIVATE"

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.beanConstructorVisibility(Visibility)

Returns:

The annotation value.

Default:

""

beanFieldVisibility

String beanFieldVisibility

Minimum bean field visibility.

Only look for bean fields with the specified minimum visibility.

This affects which fields on a bean class are considered bean properties.
Normally only public fields are considered.
Use this setting if you want to reduce the visibility requirement.

• "PUBLIC" (default)
• "PROTECTED"
• "DEFAULT"
• "PRIVATE"

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.beanFieldVisibility(Visibility)

Returns:

The annotation value.

Default:

""

beanMapPutReturnsOldValue

String beanMapPutReturnsOldValue

BeanMap.put() returns old property value.

If "true", then the BeanMap.put() method will return old property values.
Otherwise, it returns null.

• "true"
• "false" (default because it introduces a slight performance penalty during serialization)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.beanMapPutReturnsOldValue()

Returns:

The annotation value.

Default:

""

beanMethodVisibility

String beanMethodVisibility

Minimum bean method visibility.

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 public getters and setters are considered.
Use this setting if you want to reduce the visibility requirement.

• "PUBLIC" (default)
• "PROTECTED"
• "DEFAULT"
• "PRIVATE"

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.beanMethodVisibility(Visibility)

Returns:

The annotation value.

Default:

""

beansRequireDefaultConstructor

String beansRequireDefaultConstructor

Beans require no-arg constructors.

If "true", 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.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").
• The @Bean annotation can be used on a class to override this setting when "true".

See Also:

• BeanContext.Builder.beansRequireDefaultConstructor()

Returns:

The annotation value.

Default:

""

beansRequireSerializable

String beansRequireSerializable

Beans require Serializable interface.

If "true", 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.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").
• The @Bean annotation can be used on a class to override this setting when "true".

See Also:

• BeanContext.Builder.beansRequireSerializable()

Returns:

The annotation value.

Default:

""

beansRequireSettersForGetters

String beansRequireSettersForGetters

Beans require setters for getters.

If "true", only getters that have equivalent setters will be considered as properties on a bean.
Otherwise, they will be ignored.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.beansRequireSettersForGetters()

Returns:

The annotation value.

Default:

""

disableBeansRequireSomeProperties

String disableBeansRequireSomeProperties

Beans don't require at least one property.

If "true", then a Java class doesn't need to contain at least 1 property to be considered a bean.
Otherwise, the bean will be serialized as a string using the Object.toString() method.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.disableBeansRequireSomeProperties()

Returns:

The annotation value.

Default:

""

typePropertyName

String typePropertyName

Bean type property name.

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.

Notes:

• Default value: "_type".
• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• Bean.typePropertyName()
• BeanContext.Builder.typePropertyName(String)

Returns:

The annotation value.

Default:

""

debug

String debug

Debug mode.

Enables the following additional information during serialization:

• When bean getters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.
• Enables BeanTraverseContext.Builder.detectRecursions().

Enables the following additional information during parsing:

• When bean setters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• Context.Builder.debug()

Returns:

The annotation value.

Default:

""

dictionary

Class<?>[] dictionary

Bean dictionary.

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 Foo has a type-name of "myfoo", then it would end up serialized as "{_type:'myfoo',...}".

This setting tells the parsers which classes to look for when resolving "_type" attributes.

See Also:

• Bean.dictionary()
• Beanp.dictionary()
• dictionary_replace()
• BeanContext.Builder.beanDictionary(Class...)
• Bean Names and Dictionaries

Returns:

The annotation value.

Default:

{}

dictionary_replace

Class<?>[] dictionary_replace

Replace bean dictionary.

Same as dictionary() but replaces any existing value.

See Also:

• Bean.dictionary()
• Beanp.dictionary()
• dictionary()
• BeanContext.Builder.beanDictionary(Class...)

Returns:

The annotation value.

Default:

{}

findFluentSetters

String findFluentSetters

Find fluent setters.

When enabled, fluent setters are detected on beans.

Fluent setters must have the following attributes:

• Public.
• Not static.
• Take in one parameter.
• Return the bean itself.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• Bean.findFluentSetters()
• BeanContext.Builder.findFluentSetters()

Returns:

The annotation value.

Default:

""

ignoreInvocationExceptionsOnGetters

String ignoreInvocationExceptionsOnGetters

Ignore invocation errors on getters.

If "true", errors thrown when calling bean getter methods will silently be ignored.
Otherwise, a BeanRuntimeException is thrown.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.ignoreInvocationExceptionsOnGetters()

Returns:

The annotation value.

Default:

""

ignoreInvocationExceptionsOnSetters

String ignoreInvocationExceptionsOnSetters

Ignore invocation errors on setters.

If "true", errors thrown when calling bean setter methods will silently be ignored.
Otherwise, a BeanRuntimeException is thrown.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.ignoreInvocationExceptionsOnSetters()

Returns:

The annotation value.

Default:

""

disableIgnoreMissingSetters

String disableIgnoreMissingSetters

Don't silently ignore missing setters.

If "true", trying to set a value on a bean property without a setter will throw a BeanRuntimeException.
Otherwise it will be sliently ignored.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.disableIgnoreMissingSetters()

Returns:

The annotation value.

Default:

""

disableIgnoreTransientFields

String disableIgnoreTransientFields

Don't ignore transient fields.

If true, methods and fields marked as transient will not be ignored as bean properties.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.disableIgnoreTransientFields()

Returns:

The annotation value.

Default:

""

ignoreUnknownBeanProperties

String ignoreUnknownBeanProperties

Ignore unknown properties.

If "true", trying to set a value on a non-existent bean property will silently be ignored.
Otherwise, a RuntimeException is thrown.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.ignoreUnknownBeanProperties()

Returns:

The annotation value.

Default:

""

ignoreUnknownEnumValues

String ignoreUnknownEnumValues

Ignore unknown enum values.

If "true", unknown enum values are set to null instead of throwing an exception.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.ignoreUnknownEnumValues()

Returns:

The annotation value.

Default:

""

disableIgnoreUnknownNullBeanProperties

String disableIgnoreUnknownNullBeanProperties

Don't ignore unknown properties with null values.

If "true", trying to set a null value on a non-existent bean property will throw a BeanRuntimeException. Otherwise it will be silently ignored.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.disableIgnoreUnknownNullBeanProperties()

Returns:

The annotation value.

Default:

""

interfaces

Class<?>[] interfaces

Identifies a set of interfaces.

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.

// Parent class or interface public abstract class A { public String foo = "foo"; } // Sub class public class A1 extends A { public String bar = "bar"; } // Apply it to a config @BeanConfig( interfaces={ A.class } )

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.

Notes:

• The @Bean(interfaceClass) annotation is the equivalent annotation-based solution.

Returns:

The annotation value.

Default:

{}

locale

String locale

Locale.

Specifies the default locale for serializer and parser sessions.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanSession.Builder.locale(Locale)
• BeanContext.Builder.locale(Locale)

Returns:

The annotation value.

Default:

""

mediaType

String mediaType

Media type.

Specifies the default media type value for serializer and parser sessions.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanSession.Builder.mediaType(MediaType)
• BeanContext.Builder.mediaType(MediaType)

Returns:

The annotation value.

Default:

""

notBeanClasses

Class<?>[] notBeanClasses

Bean class exclusions.

List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to Strings during serialization.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanIgnore
• BeanContext.Builder.notBeanClasses(Class...)

Returns:

The annotation value.

Default:

{}

notBeanClasses_replace

Class<?>[] notBeanClasses_replace

Replace classes that should not be considered beans.

Same as notBeanClasses() but replaces any existing value.

See Also:

• BeanContext.Builder.notBeanClasses(Class...)

Returns:

The annotation value.

Default:

{}

notBeanPackages

String[] notBeanPackages

Bean package exclusions.

When specified, the current list of ignore packages are appended to.

Any classes within these packages will be serialized to strings using Object.toString().

Note that you can specify suffix patterns to include all subpackages.

Notes:

• The default value excludes the following packages:
  • java.lang
  • java.lang.annotation
  • java.lang.ref
  • java.lang.reflect
  • java.io
  • java.net
  • java.nio.*
  • java.util.*
• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.notBeanPackages(String...)

Returns:

The annotation value.

Default:

{}

notBeanPackages_replace

String[] notBeanPackages_replace

Replace packages whose classes should not be considered beans.

Same as notBeanPackages() but replaces any existing value.

See Also:

• BeanContext.Builder.notBeanPackages(String...)

Returns:

The annotation value.

Default:

{}

propertyNamer

Class<? extends PropertyNamer> propertyNamer

Bean property namer.

The class to use for calculating bean property names.

Predefined classes:

• BasicPropertyNamer (default)
• PropertyNamerDLC - Dashed-lower-case names.
• PropertyNamerULC - Dashed-upper-case names.

See Also:

• BeanContext.Builder.propertyNamer(Class)

Returns:

The annotation value.

Default:

org.apache.juneau.PropertyNamer.Void.class

sortProperties

String sortProperties

Sort bean properties.

When true, 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.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.sortProperties()

Returns:

The annotation value.

Default:

""

swaps

Class<?>[] swaps

Java object swaps.

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 Calendar object that gets swapped out for an ISO8601 string.

Multiple swaps can be associated with a single class.
When multiple swaps are applicable to the same class, the media type pattern defined by ObjectSwap.forMediaTypes() or @Swap(mediaTypes) are used to come up with the best match.

See Also:

• BeanContext.Builder.swaps(Class...)
• Swaps
• Per-media-type Swaps
• One-way Swaps
• @Swap Annotation
• Auto-detected swaps
• Surrogate Classes

Returns:

The annotation value.

Default:

{}

swaps_replace

Class<?>[] swaps_replace

Replace Java object swap classes.

Same as swaps() but replaces any existing value.

See Also:

• BeanContext.Builder.swaps(Class...)

Returns:

The annotation value.

Default:

{}

timeZone

String timeZone

Time zone.

Specifies the default timezone for serializer and parser sessions.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanSession.Builder.timeZone(TimeZone)
• BeanContext.Builder.timeZone(TimeZone)

Returns:

The annotation value.

Default:

""

useEnumNames

String useEnumNames

Use enum names.

When enabled, enums are always serialized by name, not using Object.toString().

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.useEnumNames()

Returns:

The annotation value.

Default:

""

disableInterfaceProxies

String disableInterfaceProxies

Don't use interface proxies.

Disables the feature where interfaces will be instantiated as proxy classes through the use of an InvocationHandler if there is no other way of instantiating them.
Setting this to "true" causes this to be a BeanRuntimeException.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.disableInterfaceProxies()

Returns:

The annotation value.

Default:

""

useJavaBeanIntrospector

String useJavaBeanIntrospector

Use Java Introspector.

Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
Most @Bean annotations will be ignored.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• BeanContext.Builder.useJavaBeanIntrospector()

Returns:

The annotation value.

Default:

""