net.sf.mmm.util.bean.impl

Class BeanAccessBase<BEAN extends Bean>

java.lang.Object

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

Type Parameters:

BEAN - the generic type of the intercepted bean.

All Implemented Interfaces:

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

Direct Known Subclasses:

BeanAccessInstance, BeanAccessPrototype

public abstract class BeanAccessBase<BEAN extends Bean>
extends Object
implements InvocationHandler, BeanAccess, Iterable<WritableProperty<?>>

This is the abstract base implementation of BeanAccess.

Since:

8.0.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private BEAN	bean
private Class<BEAN>	beanClass
private BeanFactoryImpl	beanFactory
(package private) static org.slf4j.Logger	LOG

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

PROPERTY_TYPE

Constructor Summary

Constructors

Constructor and Description
BeanAccessBase(Class<BEAN> beanClass, BeanFactoryImpl beanFactory) The constructor.
BeanAccessBase(Class<BEAN> beanClass, BeanFactoryImpl beanFactory, Class<?>... interfaces) The constructor.

Method Summary

Modifier and Type	Method and Description
void	fromJson(javax.json.stream.JsonParser json) Deserializes this object from JSON (JavaScript-Object-Notation).
protected void	fromJsonProperty(javax.json.stream.JsonParser json) Called from fromJson(JsonParser) to parse a single property.
protected void	fromJsonUndefinedProperty(javax.json.stream.JsonParser json, String propertyName) Called from fromJsonProperty(JsonParser) to parse a property that does not (yet) exist.
(package private) static <BEAN extends Bean> BeanAccessBase<BEAN>	get(BEAN bean)
BEAN	getBean()
Class<BEAN>	getBeanClass()
protected JsonUtil	getJsonUtil()
Iterable<WritableProperty<?>>	getProperties()
protected abstract WritableProperty<?>	getProperty(BeanPrototypeProperty prototypeProperty, boolean create) Gets the WritableProperty for the given index.
protected abstract BeanAccessPrototype<BEAN>	getPrototype()
Object	invoke(Object proxy, Method method, Object[] args)
boolean	isReadOnly()
protected void	requireWritable(String propertyName)
void	toJson(javax.json.stream.JsonGenerator json) Serializes this object as JSON (JavaScript-Object-Notation).

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

addPropertyValidator, addPropertyValidators, createProperty, createProperty, createProperty, getAliases, getDeclaredPropertyNames, getOrCreateProperty, getOrCreateProperty, getOrCreateProperty, getPackageName, getProperty, getPropertyNameForAlias, getPropertyNames, getPropertyValue, getQualifiedName, getRequiredProperty, getSimpleName, isDynamic, isPrototype, isVirtual, setPropertyValue, setPropertyValue, validate

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

LOG

static final org.slf4j.Logger LOG

beanClass

private final Class<BEAN extends Bean> beanClass

bean

private final BEAN extends Bean bean

beanFactory

private final BeanFactoryImpl beanFactory

Constructor Detail

BeanAccessBase

public BeanAccessBase(Class<BEAN> beanClass,
                      BeanFactoryImpl beanFactory)

The constructor.

Parameters:

beanClass - - see getBeanClass().

beanFactory - the owning BeanFactoryImpl.

BeanAccessBase

public BeanAccessBase(Class<BEAN> beanClass,
                      BeanFactoryImpl beanFactory,
                      Class<?>... interfaces)

The constructor.

Parameters:

beanClass - - see getBeanClass().

beanFactory - the owning BeanFactoryImpl.

interfaces - an array with optional Bean interfaces to be implemented by the dynamic proxy.

Method Detail

getBeanClass

public Class<BEAN> getBeanClass()

Specified by:

getBeanClass in interface BeanAccess

Returns:

the Class reflecting the owning Bean.

getBean

public BEAN getBean()

Returns:

the Bean proxy instance to intercept.

getPrototype

protected abstract BeanAccessPrototype<BEAN> getPrototype()

Returns:

the BeanAccessPrototype.

getProperties

public Iterable<WritableProperty<?>> getProperties()

Specified by:

getProperties in interface BeanAccess

Returns:

an Iterable with all the properties of this Bean.

getProperty

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

Gets the WritableProperty for the given index.

Parameters:

prototypeProperty - is the BeanPrototypeProperty.

create - - 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.

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface BeanAccess

Returns:

true if this BeanAccess belongs to a Bean that is read-only (immutable), false otherwise.

See Also:

AbstractBeanFactory.getReadOnlyBean(Bean)

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable

getJsonUtil

protected final JsonUtil getJsonUtil()

Returns:

the JsonUtil to use.

get

static <BEAN extends Bean> BeanAccessBase<BEAN> get(BEAN bean)

requireWritable

protected void requireWritable(String propertyName)
                        throws ReadOnlyException

Parameters:

propertyName - the optional property name or null for write on the entire Bean itself.

Throws:

ReadOnlyException - if this Bean is read-only.

toJson

public void toJson(javax.json.stream.JsonGenerator json)

Description copied from interface: JsonSupport

Serializes this object as JSON (JavaScript-Object-Notation).

Specified by:

toJson in interface JsonSupport

Parameters:

json - the JsonGenerator where to write this object to. Has to be in JsonGenerator.writeStartObject() state.

See Also:

JsonUtil.write(JsonGenerator, String, Object)

fromJson

public void fromJson(javax.json.stream.JsonParser json)

Description copied from interface: JsonSupport

Deserializes this object from JSON (JavaScript-Object-Notation). This operation is typically NOT symmetric to JsonSupport.toJson(JsonGenerator) - e.g. JsonSupport.toJson(JsonGenerator) might write a property with its value while JsonSupport.fromJson(JsonParser) may only deserialze the value as the parent object has to handle the property names that may appear in any order.

Specified by:

fromJson in interface JsonSupport

Parameters:

json - the JsonParser to read from.

fromJsonProperty

protected void fromJsonProperty(javax.json.stream.JsonParser json)

Called from fromJson(JsonParser) to parse a single property.

Parameters:

json - the JsonParser.

fromJsonUndefinedProperty

protected void fromJsonUndefinedProperty(javax.json.stream.JsonParser json,
                                         String propertyName)

Called from fromJsonProperty(JsonParser) to parse a property that does not (yet) exist.

Parameters:

json - the JsonParser.

propertyName - the name of the missing property to parse.