org.apache.juneau

Class BeanMeta<T>

java.lang.Object

org.apache.juneau.BeanMeta<T>

Type Parameters:

T - The class type that this metadata applies to.

Direct Known Subclasses:

BeanMetaFiltered

public class BeanMeta<T>
extends Object

Encapsulates all access to the properties of a bean class (like a souped-up BeanInfo).

Description

Uses introspection to find all the properties associated with this class. If the @Bean annotation is present on the class, or the class has a BeanFilter registered with it in the bean context, then that information is used to determine the properties on the class. Otherwise, the BeanInfo functionality in Java is used to determine the properties on the class.

Bean property ordering

The order of the properties are as follows:

• If @Bean annotation is specified on class, then the order is the same as the list of properties in the annotation.
• If @Bean annotation is not specified on the class, then the order is based on the following.
  • Public fields (same order as Class.getFields()).
  • Properties returned by BeanInfo.getPropertyDescriptors().
  • Non-standard getters/setters with @Beanp annotation defined on them.

The order can also be overridden through the use of an BeanFilter.

Field Summary

Fields

Modifier and Type	Field and Description
protected BeanFilter	beanFilter Optional bean filter associated with the target class.
protected Class<T>	c The target class that this meta object describes.
protected ClassMeta<T>	classMeta The target class type that this meta object describes.
protected ConstructorInfo	constructor The constructor for this bean.
protected String[]	constructorArgs For beans with constructors with Beanc annotation, this is the list of constructor arg properties.
protected BeanContext	ctx The bean context that created this metadata object.
protected Map<Method,String>	getterProps The getter properties on the target class.
protected Map<String,BeanPropertyMeta>	properties The properties on the target class.
protected Map<Method,String>	setterProps The setter properties on the target class.
protected Map<Class<?>,Class<?>[]>	typeVarImpls Type variables implemented by this bean.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanMeta(ClassMeta<T> classMeta, BeanContext ctx, BeanFilter beanFilter, String[] pNames) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ClassMeta<T>	getClassMeta() Returns the ClassMeta of this bean.
String	getDictionaryName() Returns the dictionary name for this bean as defined through the @Bean(typeName) annotation.
BeanPropertyMeta	getPropertyMeta(String name) Returns metadata about the specified property.
Collection<BeanPropertyMeta>	getPropertyMetas() Returns the metadata on all properties associated with this bean.
Collection<BeanPropertyMeta>	getPropertyMetas(String... pNames) Returns the metadata on the specified list of properties.
BeanPropertyMeta	getTypeProperty() Returns a mock bean property that resolves to the name "_type" and whose value always resolves to the dictionary name of the bean.
int	hashCode()
protected T	newBean(Object outer) Creates a new instance of this bean.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

classMeta

protected final ClassMeta<T> classMeta

The target class type that this meta object describes.

c

protected final Class<T> c

The target class that this meta object describes.

properties

protected final Map<String,BeanPropertyMeta> properties

The properties on the target class.

getterProps

protected final Map<Method,String> getterProps

The getter properties on the target class.

setterProps

protected final Map<Method,String> setterProps

The setter properties on the target class.

ctx

protected final BeanContext ctx

The bean context that created this metadata object.

beanFilter

protected final BeanFilter beanFilter

Optional bean filter associated with the target class.

typeVarImpls

protected final Map<Class<?>,Class<?>[]> typeVarImpls

Type variables implemented by this bean.

constructor

protected final ConstructorInfo constructor

The constructor for this bean.

constructorArgs

protected final String[] constructorArgs

For beans with constructors with Beanc annotation, this is the list of constructor arg properties.

Constructor Detail

BeanMeta

protected BeanMeta(ClassMeta<T> classMeta,
                   BeanContext ctx,
                   BeanFilter beanFilter,
                   String[] pNames)

Constructor.

Parameters:

classMeta - The target class.

ctx - The bean context that created this object.

beanFilter - Optional bean filter associated with the target class. Can be null.

pNames - Explicit list of property names and order of properties. If null, determine automatically.

Method Detail

getClassMeta

@BeanIgnore
public final ClassMeta<T> getClassMeta()

Returns the ClassMeta of this bean.

Returns:

The ClassMeta of this bean.

getDictionaryName

public final String getDictionaryName()

Returns the dictionary name for this bean as defined through the @Bean(typeName) annotation.

Returns:

The dictionary name for this bean, or null if it has no dictionary name defined.

getTypeProperty

public final BeanPropertyMeta getTypeProperty()

Returns a mock bean property that resolves to the name "_type" and whose value always resolves to the dictionary name of the bean.

Returns:

The type name property.

getPropertyMetas

public Collection<BeanPropertyMeta> getPropertyMetas()

Returns the metadata on all properties associated with this bean.

Returns:

Metadata on all properties associated with this bean.

getPropertyMetas

public Collection<BeanPropertyMeta> getPropertyMetas(String... pNames)

Returns the metadata on the specified list of properties.

Parameters:

pNames - The list of properties to retrieve. If null, returns all properties.

Returns:

The metadata on the specified list of properties.

getPropertyMeta

public BeanPropertyMeta getPropertyMeta(String name)

Returns metadata about the specified property.

Parameters:

name - The name of the property on this bean.

Returns:

The metadata about the property, or null if no such property exists on this bean.

newBean

protected T newBean(Object outer)
             throws ExecutableException

Creates a new instance of this bean.

Parameters:

outer - The outer object if bean class is a non-static inner member class.

Returns:

A new instance of this bean if possible, or null if not.

Throws:

ExecutableException - Exception occurred on invoked constructor/method/field.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object