net.sf.mmm.util.bean.impl

Class BeanAccessInstance<BEAN extends Bean>

java.lang.Object

net.sf.mmm.util.bean.impl.BeanAccessBase<BEAN>

net.sf.mmm.util.bean.impl.BeanAccessInstance<BEAN>

Type Parameters:

BEAN - the generic type of the intercepted bean.

All Implemented Interfaces:

Iterable<WritableProperty<?>>, InvocationHandler, BeanAccess, JsonSupport

Direct Known Subclasses:

BeanAccessMutable, BeanAccessReadOnly

public abstract class BeanAccessInstance<BEAN extends Bean>
extends BeanAccessBase<BEAN>

The abstract base implementation of BeanAccess for a regular Bean instance.

Since:

8.0.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private WritableProperty<?>[]	properties
private BeanAccessPrototype<BEAN>	prototype

Fields inherited from class net.sf.mmm.util.bean.impl.BeanAccessBase

LOG

Fields inherited from interface net.sf.mmm.util.json.api.JsonSupport

PROPERTY_TYPE

Constructor Summary

Constructors

Constructor and Description
BeanAccessInstance(BeanFactoryImpl beanFactory, BeanAccessPrototype<BEAN> prototype) The constructor.

Method Summary

Modifier and Type	Method and Description
<V,PROPERTY extends WritableProperty<V>> void	addPropertyValidator(WritableProperty<?> property, AbstractValidator<? super V> validator) This method updates a given property such that the provided validator is added.
<V,PROPERTY extends WritableProperty<V>> void	addPropertyValidators(WritableProperty<?> property, Collection<AbstractValidator<? super V>> validators) This method updates a given property such that the provided validator is added.
(package private) void	createProperties()
protected abstract WritableProperty<?>	createProperty(BeanPrototypeProperty prototypeProperty)
<V,PROPERTY extends WritableProperty<V>> PROPERTY	createProperty(String name, GenericType<? extends V> valueType, Class<PROPERTY> propertyType) Creates and adds the specified WritableProperty on the fly.
<V> WritableProperty<V>	createProperty(String name, GenericType<V> type) Creates and adds the specified WritableProperty on the fly.
Iterable<String>	getAliases()
Set<String>	getDeclaredPropertyNames()
String	getPackageName()
protected WritableProperty<?>	getProperty(BeanPrototypeProperty prototypeProperty, boolean required) Gets the WritableProperty for the given index.
WritableProperty<?>	getProperty(String propertyName)
String	getPropertyNameForAlias(String alias) An alias is an alternative for a property name.
Set<String>	getPropertyNames()
BeanAccessPrototype<BEAN>	getPrototype()
String	getQualifiedName()
String	getSimpleName()
boolean	isDynamic()
boolean	isPrototype()
boolean	isVirtual()
Iterator<WritableProperty<?>>	iterator()

Methods inherited from class net.sf.mmm.util.bean.impl.BeanAccessBase

fromJson, fromJsonProperty, fromJsonUndefinedProperty, get, getBean, getBeanClass, getJsonUtil, getProperties, invoke, isReadOnly, requireWritable, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.bean.api.BeanAccess

createProperty, getOrCreateProperty, getOrCreateProperty, getOrCreateProperty, getPropertyValue, getRequiredProperty, setPropertyValue, setPropertyValue, validate

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

prototype

private final BeanAccessPrototype<BEAN extends Bean> prototype

properties

private WritableProperty<?>[] properties

Constructor Detail

BeanAccessInstance

public BeanAccessInstance(BeanFactoryImpl beanFactory,
                          BeanAccessPrototype<BEAN> prototype)

The constructor.

Parameters:

beanFactory - the owning BeanFactoryImpl.

prototype - the BeanAccessPrototype.

Method Detail

getPrototype

public BeanAccessPrototype<BEAN> getPrototype()

Specified by:

getPrototype in class BeanAccessBase<BEAN extends Bean>

Returns:

the BeanAccessPrototype.

getSimpleName

public String getSimpleName()

Returns:

the simple name of the Bean. The last segment of the BeanAccess.getQualifiedName() (excluding the package name).

See Also:

BeanAccess.getQualifiedName()

getQualifiedName

public String getQualifiedName()

Returns:

the qualified name of the bean interface. By default derived from Class.getName() of the bean-interface. Will be overridden if a Named annotation is present at the interface. If the Named.value() of the Named annotation is unqualified (contains no dot) then the package of the bean interface is appended. Further the name can be provided when dynamic bean prototypes are created. Again if an unqualified name is provided as argument, the package of the bean interface is appended.

getProperty

public WritableProperty<?> getProperty(String propertyName)

Parameters:

propertyName - the name of the requested property or a potential alias of the property.

Returns:

the requested WritableProperty or null if no such property exists.

iterator

public Iterator<WritableProperty<?>> iterator()

getAliases

public Iterable<String> getAliases()

Returns:

an Iterable with all defined aliases.

getPropertyNameForAlias

public String getPropertyNameForAlias(String alias)

Description copied from interface: BeanAccess

An alias is an alternative for a property name. It is defined by annotating the property method with Named and allows to support a property under a legacy name after it has been renamed as well as to use a technical name containing special characters (e.g. "@" or ".") for very specific cases.

Parameters:

alias - the alias name.

Returns:

the resolved property name or null if no such alias is defined.

getPropertyNames

public Set<String> getPropertyNames()

Returns:

an immutable Set with the names of the properties.

getDeclaredPropertyNames

public Set<String> getDeclaredPropertyNames()

Returns:

an immutable Set with the names of the properties declared by this bean class. In other words a sub-set of BeanAccess.getPropertyNames() is returned that excludes the names of the inherited properties.

See Also:

Class.getDeclaredFields()

getPackageName

public String getPackageName()

Returns:

the package name of the bean class. The qualified name excluding the simple name. Will be the empty string for the default package (then BeanAccess.getQualifiedName() is equal to BeanAccess.getSimpleName()).

See Also:

BeanAccess.getQualifiedName()

getProperty

protected WritableProperty<?> getProperty(BeanPrototypeProperty prototypeProperty,
                                          boolean required)

Description copied from class: BeanAccessBase

Gets the WritableProperty for the given index.

Specified by:

getProperty in class BeanAccessBase<BEAN extends Bean>

Parameters:

prototypeProperty - is the BeanPrototypeProperty.

required - - true if the property is required and shall be created if it does not already exist, false otherwise.

Returns:

the requested WritableProperty. May be null.

createProperty

public <V> WritableProperty<V> createProperty(String name,
                                              GenericType<V> type)

Description copied from interface: BeanAccess

Creates and adds the specified WritableProperty on the fly. Creating and adding new properties is only possible for dynamic beans.

Type Parameters:

V - the generic type of the property value.

Parameters:

name - the property name.

type - the property type.

Returns:

the newly created property.

createProperty

public <V,PROPERTY extends WritableProperty<V>> PROPERTY createProperty(String name,
                                                                        GenericType<? extends V> valueType,
                                                                        Class<PROPERTY> propertyType)

Description copied from interface: BeanAccess

Creates and adds the specified WritableProperty on the fly. Creating and adding new properties is only possible for dynamic beans.

Type Parameters:

V - the generic type of the property value.

PROPERTY - the generic type of the property.

Parameters:

name - the property name.

propertyType - the Class reflecting the WritableProperty to create.

Returns:

the newly created property.

createProperties

void createProperties()

createProperty

protected abstract WritableProperty<?> createProperty(BeanPrototypeProperty prototypeProperty)

Parameters:

prototypeProperty - the BeanPrototypeProperty.

Returns:

a new WritableProperty instance copied from the given BeanPrototypeProperty.

isDynamic

public boolean isDynamic()

Returns:

true if this BeanAccess belongs to a dynamic Bean. Dynamic means that the Bean is not strictly typed and allows to create and add properties on the fly, false otherwise.

See Also:

BeanPrototypeBuilder.isDynamic(), BeanPrototypeBuilder.getOrCreatePrototype(Class)

isVirtual

public boolean isVirtual()

Returns:

true if this BeanAccess belongs to a virtual Bean. Virtual means that the prototype of the bean has been created via BeanPrototypeBuilder.createPrototype(Class, String, Bean...) and represents a class (interface) that does not exist as Java Class, false otherwise.

See Also:

BeanPrototypeBuilder.createPrototype(Class, String, Bean...)

isPrototype

public boolean isPrototype()

Returns:

true if this BeanAccess belongs to a prototype, false otherwise (if it belongs to an instance).

See Also:

BeanFactory.createPrototype(Class), AbstractBeanFactory.getPrototype(Bean), BeanPrototypeBuilder.getOrCreatePrototype(Class), BeanPrototypeBuilder.createPrototype(Class, String, Bean...)

addPropertyValidator

public <V,PROPERTY extends WritableProperty<V>> void addPropertyValidator(WritableProperty<?> property,
                                                                          AbstractValidator<? super V> validator)

Description copied from interface: BeanAccess

This method updates a given property such that the provided validator is added. Therefore the Bean has to be a dynamic prototype that is not read-only.

Type Parameters:

V - the generic type of the property value.

PROPERTY - the generic type of the property.

Parameters:

property - the property to update. Has to be owned by the owning Bean.

validator - is the validator to add. The implementation tries its best to be idempotent so adding the same validator again should have no effect.

addPropertyValidators

public <V,PROPERTY extends WritableProperty<V>> void addPropertyValidators(WritableProperty<?> property,
                                                                           Collection<AbstractValidator<? super V>> validators)

Description copied from interface: BeanAccess

This method updates a given property such that the provided validator is added. Therefore the Bean has to be a dynamic prototype that is not read-only.

Type Parameters:

V - the generic type of the property value.

PROPERTY - the generic type of the property.

Parameters:

property - the property to update. Has to be owned by the owning Bean.

validators - is the Collection with the validators to add. The implementation tries its best to be idempotent so adding the same validator again should have no effect.