org.apache.juneau

Class BeanPropertyMeta

java.lang.Object

org.apache.juneau.BeanPropertyMeta

public final class BeanPropertyMeta
extends Object

Contains metadata about a bean property.

Contains information such as type of property (e.g. field/getter/setter), class type of property value, and whether any transforms are associated with this property.

Developers will typically not need access to this class. The information provided by it is already exposed through several methods on the BeanMap API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeanPropertyMeta.Builder BeanPropertyMeta builder class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanPropertyMeta(BeanPropertyMeta.Builder b) Creates a new BeanPropertyMeta using the contents of the specified builder.

Method Summary

Modifier and Type	Method and Description
void	add(BeanMap<?> m, String pName, Object value) Adds a value to a Collection or array property.
void	add(BeanMap<?> m, String pName, String key, Object value) Adds a value to a Map or bean property.
static BeanPropertyMeta.Builder	builder(BeanMeta<?> beanMeta, String name) Creates a builder for BeanPropertyMeta(org.apache.juneau.BeanPropertyMeta.Builder) objects.
boolean	canRead() Returns true if this property can be read.
boolean	canWrite() Returns true if this property can be written.
<A extends Annotation> A	findAnnotation(Class<A> a) Returns the specified annotation on the field or methods that define this property.
<A extends Annotation> List<A>	findAnnotations(Class<A> a) Returns all instances of the specified annotation in the hierarchy of this bean property.
Object	get(BeanMap<?> m, String pName) Equivalent to calling BeanMap.get(Object), but is faster since it avoids looking up the property meta.
<A extends Annotation> A	getAnnotation(Class<A> a) Deprecated. Use findAnnotation(Class)
BeanMeta<?>	getBeanMeta() Returns the bean meta that this property belongs to.
BeanRegistry	getBeanRegistry() Returns the bean dictionary in use for this bean property.
ClassMeta<?>	getClassMeta() Returns the ClassMeta of the class of this property.
Map<String,Object>	getDynaMap(Object bean) Returns the Map object returned by the DynaBean getter.
<M extends BeanPropertyMetaExtended> M	getExtendedMeta(Class<M> c) Returns the language-specified extended metadata on this bean property.
Field	getField() Returns the field for this property.
Method	getGetter() Returns the getter method for this property.
Field	getInnerField() Returns the field for this property even if the field is private.
String	getName() Returns the name of this bean property.
String[]	getProperties() Returns the override list of properties defined through a @BeanProperty(properties) annotation on this property.
Object	getRaw(BeanMap<?> m, String pName) Equivalent to calling BeanMap.getRaw(Object), but is faster since it avoids looking up the property meta.
Method	getSetter() Returns the setter method for this property.
boolean	isDyna() Returns true if this bean property is named "*".
boolean	isUri() Returns true if this bean property is a URI.
Object	set(BeanMap<?> m, String pName, Object value) Equivalent to calling BeanMap.put(String, Object), but is faster since it avoids looking up the property meta.
protected void	setArray(Object bean, List l) Sets an array field on this bean.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BeanPropertyMeta

protected BeanPropertyMeta(BeanPropertyMeta.Builder b)

Creates a new BeanPropertyMeta using the contents of the specified builder.

Parameters:

b - The builder to copy fields from.

Method Detail

builder

public static BeanPropertyMeta.Builder builder(BeanMeta<?> beanMeta,
                                               String name)

Creates a builder for BeanPropertyMeta(org.apache.juneau.BeanPropertyMeta.Builder) objects.

Parameters:

beanMeta - The metadata on the bean

name - The bean property name.

Returns:

A new builder.

getName

public String getName()

Returns the name of this bean property.

Returns:

The name of the bean property.

getBeanMeta

@BeanIgnore
public BeanMeta<?> getBeanMeta()

Returns the bean meta that this property belongs to.

Returns:

The bean meta that this property belongs to.

getGetter

public Method getGetter()

Returns the getter method for this property.

Returns:

The getter method for this bean property, or null if there is no getter method.

getSetter

public Method getSetter()

Returns the setter method for this property.

Returns:

The setter method for this bean property, or null if there is no setter method.

getField

public Field getField()

Returns the field for this property.

Returns:

The field for this bean property, or null if there is no field associated with this bean property.

getInnerField

public Field getInnerField()

Returns the field for this property even if the field is private.

Returns:

The field for this bean property, or null if there is no field associated with this bean property.

getClassMeta

public ClassMeta<?> getClassMeta()

Returns the ClassMeta of the class of this property.

If this property or the property type class has a PojoSwap associated with it, this method returns the transformed class meta. This matches the class type that is used by the get(BeanMap,String) and set(BeanMap,String,Object) methods.

Returns:

The ClassMeta of the class of this property.

getBeanRegistry

public BeanRegistry getBeanRegistry()

Returns the bean dictionary in use for this bean property.

The order of lookup for the dictionary is as follows:

1. Dictionary defined via @BeanProperty(beanDictionary).
2. Dictionary defined via BeanContext.BEAN_beanDictionary context property.

Returns:

The bean dictionary in use for this bean property. Never null.

isUri

public boolean isUri()

Returns true if this bean property is a URI.

A bean property can be considered a URI if any of the following are true:

• Property class type is URL or URI.
• Property class type is annotated with @URI.
• Property getter, setter, or field is annotated with @URI.

Returns:

true if this bean property is a URI.

isDyna

public boolean isDyna()

Returns true if this bean property is named "*".

Returns:

true if this bean property is named "*".

getProperties

public String[] getProperties()

Returns the override list of properties defined through a @BeanProperty(properties) annotation on this property.

Returns:

The list of override properties, or null if annotation not specified.

getExtendedMeta

public <M extends BeanPropertyMetaExtended> M getExtendedMeta(Class<M> c)

Returns the language-specified extended metadata on this bean property.

Parameters:

c - The name of the metadata class to create.

Returns:

Extended metadata on this bean property. Never null.

get

public Object get(BeanMap<?> m,
                  String pName)

Equivalent to calling BeanMap.get(Object), but is faster since it avoids looking up the property meta.

Parameters:

m - The bean map to get the transformed value from.

pName - The property name.

Returns:

The property value.

getRaw

public Object getRaw(BeanMap<?> m,
                     String pName)

Equivalent to calling BeanMap.getRaw(Object), but is faster since it avoids looking up the property meta.

Parameters:

m - The bean map to get the transformed value from.

pName - The property name.

Returns:

The raw property value.

set

public Object set(BeanMap<?> m,
                  String pName,
                  Object value)
           throws BeanRuntimeException

Equivalent to calling BeanMap.put(String, Object), but is faster since it avoids looking up the property meta.

Parameters:

m - The bean map to set the property value on.

pName - The property name.

value - The value to set.

Returns:

The previous property value.

Throws:

BeanRuntimeException - If property could not be set.

getDynaMap

public Map<String,Object> getDynaMap(Object bean)
                              throws IllegalArgumentException,
                                     IllegalAccessException,
                                     InvocationTargetException

Returns the Map object returned by the DynaBean getter.

The DynaBean property is the property whose name is "*" and returns a map of "extra" properties on the bean.

Parameters:

bean - The bean.

Returns:

The map returned by the getter, or an empty map if the getter returned null or this isn't a DynaBean property.

Throws:

IllegalArgumentException - Thrown by method invocation.

IllegalAccessException - Thrown by method invocation.

InvocationTargetException - Thrown by method invocation.

setArray

protected void setArray(Object bean,
                        List l)
                 throws IllegalArgumentException,
                        IllegalAccessException,
                        InvocationTargetException

Sets an array field on this bean.

Works on both Object and primitive arrays.

Parameters:

bean - The bean of the field.

l - The collection to use to set the array field.

Throws:

IllegalArgumentException - Thrown by method invocation.

IllegalAccessException - Thrown by method invocation.

InvocationTargetException - Thrown by method invocation.

add

public void add(BeanMap<?> m,
                String pName,
                Object value)
         throws BeanRuntimeException

Adds a value to a Collection or array property.

Note that adding values to an array property is inefficient for large arrays since it must copy the array into a larger array on each operation.

Parameters:

m - The bean of the field being set.

pName - The property name.

value - The value to add to the field.

Throws:

BeanRuntimeException - If field is not a collection or array.

add

public void add(BeanMap<?> m,
                String pName,
                String key,
                Object value)
         throws BeanRuntimeException

Adds a value to a Map or bean property.

Parameters:

m - The bean of the field being set.

pName - The property name.

key - The key to add to the field.

value - The value to add to the field.

Throws:

BeanRuntimeException - If field is not a map or array.

findAnnotations

public <A extends Annotation> List<A> findAnnotations(Class<A> a)

Returns all instances of the specified annotation in the hierarchy of this bean property.

Searches through the class hierarchy (e.g. superclasses, interfaces, packages) for all instances of the specified annotation.

Parameters:

a - The class to find annotations for.

Returns:

A list of annotations ordered in child-to-parent order. Never null.

findAnnotation

public <A extends Annotation> A findAnnotation(Class<A> a)

Returns the specified annotation on the field or methods that define this property.

This method will search up the parent class/interface hierarchy chain to search for the annotation on overridden getters and setters.

Parameters:

a - The annotation to search for.

Returns:

The annotation, or null if it wasn't found.

toString

public String toString()

Overrides:

toString in class Object

canRead

public boolean canRead()

Returns true if this property can be read.

Returns:

true if this property can be read.

canWrite

public boolean canWrite()

Returns true if this property can be written.

Returns:

true if this property can be written.

getAnnotation

@Deprecated
public <A extends Annotation> A getAnnotation(Class<A> a)

Deprecated. Use findAnnotation(Class)