org.apache.juneau.annotation

Annotation Type Bean

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Bean

Used to tailor how beans get interpreted by the framework.

This annotation can be applied to classes and interfaces.

See Also:

• Overview > juneau-marshall > @Bean Annotation

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	beanDictionary Bean dictionary.
String	excludeProperties Specifies a list of properties that should be excluded from BeanMap.entrySet().
Class<?>	interfaceClass Identifies a class to be used as the interface class for this and all subclasses.
String	properties The set and order of names of properties associated with a bean class.
Class<? extends PropertyFilter>	propertyFilter Property filter.
Class<? extends PropertyNamer>	propertyNamer Associates a PropertyNamer with this bean to tailor the names of the bean properties.
boolean	sort Sort bean properties in alphabetical order.
Class<?>	stopClass Identifies a stop class for the annotated class.
String	typeName An identifying name for this class.
String	typePropertyName The property name to use for representing the type name.

Element Detail

beanDictionary

public abstract Class<?>[] beanDictionary

Bean dictionary.

The list of classes that make up the bean dictionary for all properties in this class and all subclasses.

See Also:

• BeanContext.BEAN_beanDictionary

Default:

{}

excludeProperties

public abstract String excludeProperties

Specifies a list of properties that should be excluded from BeanMap.entrySet().

Example:

// Exclude the 'city' and 'state' properties from the Address class. @Bean(excludeProperties="city,state"}) public class Address {...}

See Also:

• BeanContext.BEAN_excludeProperties

Default:

""

interfaceClass

public abstract Class<?> interfaceClass

Identifies a class to be used as the interface class for this and all subclasses.

When specified, only the list of properties defined on the interface class will be used during serialization. Additional properties on subclasses will be ignored.

// Parent class @Bean(interfaceClass=A.class) public abstract class A { public String f0 = "f0"; } // Sub class public class A1 extends A { public String f1 = "f1"; } // Produces "{f0:'f0'}" String json = JsonSerializer.DEFAULT_LAX.serialize(new A1());

Note that 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.

See Also:

• BeanContext.BEAN_beanFilters

Default:

java.lang.Object.class

properties

public abstract String properties

The set and order of names of properties associated with a bean class.

The order specified is the same order that the entries will be returned by the BeanMap.entrySet() and related methods.

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.

Example:

// Address class with only street/city/state properties (in that order). @Bean(properties="street,city,state") public class Address {...}

See Also:

• BeanContext.BEAN_includeProperties

Default:

""

propertyFilter

public abstract Class<? extends PropertyFilter> propertyFilter

Property filter.

Property filters can be used to intercept calls to getters and setters and alter their values in transit.

See Also:

• PropertyFilter

Default:

org.apache.juneau.transform.PropertyFilter.class

propertyNamer

public abstract Class<? extends PropertyNamer> propertyNamer

Associates a PropertyNamer with this bean to tailor the names of the bean properties.

Property namers are used to transform bean property names from standard form to some other form.

Example:

// Define a class with dashed-lowercase property names. @Bean(propertyNamer=PropertyNamerDashedLC.class) public class MyBean {...}

See Also:

• BeanContext.BEAN_propertyNamer

Default:

org.apache.juneau.PropertyNamerDefault.class

sort

public abstract boolean sort

Sort bean properties in alphabetical order.

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.

Example:

// Sort bean properties alphabetically during serialization. @Bean(sort=true) public class MyBean {...}

See Also:

• BeanContext.BEAN_sortProperties

Default:

false

stopClass

public abstract Class<?> stopClass

Identifies a stop class for the annotated class.

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 C3 will include property p3, but not p1 or p2.

public class C1 { public int getP1(); } public class C2 extends C1 { public int getP2(); } @Bean(stopClass=C2.class) public class C3 extends C2 { public int getP3(); }

Default:

java.lang.Object.class

typeName

public abstract String typeName

An identifying name for this class.

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 Object, then the serializer will add the name to the output so that the class can be determined during parsing.

It is also used to specify element names in XML.

Example:

// Use _type='mybean' to identify this bean. @Bean(typeName="mybean") public class MyBean {...}

See Also:

• BeanContext.BEAN_beanDictionary

Default:

""

typePropertyName

public abstract String typePropertyName

The property name to use for representing the type name.

This can be used to override the name used for the "_type" property used by the typeName() setting.

The default value if not specified is "_type" .

Example:

// Use 'type' instead of '_type' for bean names. @Bean(typePropertyName="type") public class MyBean {...}

See Also:

• BeanContext.BEAN_beanTypePropertyName

Default:

""