net.sf.mmm.util.bean.api

Interface BeanAccess

All Superinterfaces:

JsonSupport

All Known Implementing Classes:

BeanAccessBase, BeanAccessInstance, BeanAccessMutable, BeanAccessPrototype, BeanAccessPrototypeExternal, BeanAccessPrototypeInternal, BeanAccessPrototypePolymorphic, BeanAccessPrototypeVirtual, BeanAccessReadOnly

public interface BeanAccess
extends JsonSupport

This is the interface for all generic operations on a Bean.

Since:

8.0.0

Author:

hohwille

Field Summary

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

PROPERTY_TYPE

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.
default <V,PROPERTY extends WritableProperty<V>> PROPERTY	createProperty(String name, Class<PROPERTY> propertyType) Creates and adds the specified WritableProperty on the fly.
<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.
default <V> WritableProperty<V>	createProperty(String name, GenericType<V> valueType) Creates and adds the specified WritableProperty on the fly.
Iterable<String>	getAliases()
Class<? extends Bean>	getBeanClass()
Set<String>	getDeclaredPropertyNames()
default <V,PROPERTY extends WritableProperty<V>> PROPERTY	getOrCreateProperty(String name, Class<PROPERTY> propertyType) Gets or creates the specified property.
default <V,PROPERTY extends WritableProperty<V>> PROPERTY	getOrCreateProperty(String name, GenericType<? extends V> valueType, Class<PROPERTY> propertyType) Gets or creates the specified property.
default <V> WritableProperty<V>	getOrCreateProperty(String name, GenericType<V> valueType) Gets or creates the specified property.
String	getPackageName()
Iterable<WritableProperty<?>>	getProperties()
WritableProperty<?>	getProperty(String name)
String	getPropertyNameForAlias(String alias) An alias is an alternative for a property name.
Set<String>	getPropertyNames()
default Object	getPropertyValue(String name)
String	getQualifiedName()
default WritableProperty<?>	getRequiredProperty(String name)
String	getSimpleName()
boolean	isDynamic()
boolean	isPrototype()
boolean	isReadOnly()
boolean	isVirtual()
default void	setPropertyValue(String name, Object value)
default <V> void	setPropertyValue(String name, V value, GenericType<V> type) This method sets the property with the given name to the specified value.
default ValidationFailure	validate()

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

fromJson, toJson

Method Detail

getProperties

Iterable<WritableProperty<?>> getProperties()

Returns:

an Iterable with all the properties of this Bean.

getPropertyNames

Set<String> getPropertyNames()

Returns:

an immutable Set with the names of the properties.

getDeclaredPropertyNames

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 getPropertyNames() is returned that excludes the names of the inherited properties.

See Also:

Class.getDeclaredFields()

getAliases

Iterable<String> getAliases()

Returns:

an Iterable with all defined aliases.

getPropertyNameForAlias

String getPropertyNameForAlias(String alias)

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.

getProperty

WritableProperty<?> getProperty(String name)

Parameters:

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

Returns:

the requested WritableProperty or null if no such property exists.

getBeanClass

Class<? extends Bean> getBeanClass()

Returns:

the Class reflecting the owning Bean.

getSimpleName

String getSimpleName()

Returns:

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

See Also:

getQualifiedName()

getQualifiedName

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.

getPackageName

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 getQualifiedName() is equal to getSimpleName()).

See Also:

getQualifiedName()

getRequiredProperty

default WritableProperty<?> getRequiredProperty(String name)
                                         throws PojoPropertyNotFoundException

Parameters:

name - the name of the requested property.

Returns:

the requested WritableProperty.

Throws:

PojoPropertyNotFoundException - if the requested property does not exist.

validate

default ValidationFailure validate()

Returns:

the ValidationFailure or null if this Bean is valid according to this ValueValidator.

See Also:

ValueValidator.validate(Object)

getOrCreateProperty

default <V> WritableProperty<V> getOrCreateProperty(String name,
                                                    GenericType<V> valueType)

Gets or creates the specified property. If the property already exists also the type has to match the given type or an exception will be thrown.

Type Parameters:

V - the generic type of the property value.

Parameters:

name - the property name.

valueType - the property type.

Returns:

the requested property.

getOrCreateProperty

default <V,PROPERTY extends WritableProperty<V>> PROPERTY getOrCreateProperty(String name,
                                                                              Class<PROPERTY> propertyType)

Gets or creates the specified property. If the property already exists it also has to match the given type or an exception will be thrown.

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 requested property.

getOrCreateProperty

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

Gets or creates the specified property. If the property already exists it also has to match the given type or an exception will be thrown.

Type Parameters:

V - the generic type of the property value.

PROPERTY - the generic type of the property.

Parameters:

name - the property name.

valueType - the property type.

propertyType - the Class reflecting the WritableProperty to create.

Returns:

the requested property.

getPropertyValue

default Object getPropertyValue(String name)

Parameters:

name - the name of the property.

Returns:

the value of the specified property.

setPropertyValue

default void setPropertyValue(String name,
                              Object value)

Parameters:

bean - the Bean instance.

name - the name of the property.

value - new value of the specified property.

setPropertyValue

default <V> void setPropertyValue(String name,
                                  V value,
                                  GenericType<V> type)

This method sets the property with the given name to the specified value. If the property does not already exist, it will dynamically be created.

Type Parameters:

V - the generic type of the property value.

Parameters:

name - the property name.

value - new value of the specified property. Maybe null and in such case a missing property will NOT be created.

type - the property type. May be null if the property has to be created then the type will be derived from value as fallback.

createProperty

default <V> WritableProperty<V> createProperty(String name,
                                               GenericType<V> valueType)

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.

valueType - the property type.

Returns:

the newly created property.

createProperty

default <V,PROPERTY extends WritableProperty<V>> PROPERTY createProperty(String name,
                                                                         Class<PROPERTY> propertyType)

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.

createProperty

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

valueType -

propertyType - the Class reflecting the WritableProperty to create.

Returns:

the newly created property.

addPropertyValidator

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

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

isReadOnly

boolean isReadOnly()

Returns:

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

See Also:

AbstractBeanFactory.getReadOnlyBean(Bean)

isDynamic

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)

isPrototype

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

isVirtual

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