Module io.github.mmm.bean

Package io.github.mmm.bean

Class AbstractBean

java.lang.Object

io.github.mmm.bean.AbstractBean

All Implemented Interfaces:

ReadableBean, WritableBean, io.github.mmm.marshall.id.StructuredIdMappingObject, io.github.mmm.marshall.MarshallableObject, io.github.mmm.marshall.Marshaller<Object>, io.github.mmm.marshall.Marshalling<Object>, io.github.mmm.marshall.MarshallingObject, io.github.mmm.marshall.UnmarshallableObject, io.github.mmm.marshall.Unmarshaller<Object>, AttributeReadOnly, io.github.mmm.validation.Validatable, io.github.mmm.value.ReadablePath, io.github.mmm.value.WritablePath

Direct Known Subclasses:

AbstractVirtualBean, Bean, BeanAccessor

public abstract class AbstractBean
extends Object
implements WritableBean

Abstract base implementation of WritableBean.
ATTENTION:
If you plan to implement beans as Java class instead of using interfaces, you always need to have a public constructor with WritableBean as a single argument. Otherwise read-only support can not work.

See Also:

• Bean

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.mmm.value.ReadablePath

io.github.mmm.value.ReadablePath.PathBuilder

Field Summary

Fields inherited from interface io.github.mmm.bean.ReadableBean

SUFFIX_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractBean(WritableBean writable)	The constructor.

Method Summary

Modifier and Type	Method	Description
protected PropertyBuilders	add()
protected <V, P extends WritableProperty<V>> P	add(P property)	Internal method for addProperty(WritableProperty), without verification.
<P extends WritableProperty<?>> P	addProperty(P property)	Adds the given WritableProperty to this bean.
WritableBean	copy()
protected AbstractBean	create(WritableBean writable)	Creates a new instance of this Bean implementation.
<V> WritableProperty<V>	createProperty(String name, Class<V> valueClass)	Creates and adds a WritableProperty with the given value class dynamically.
protected StandardPropertyBuilders	createPropertyBuilders()	Internal method that may be overridden to replace the StandardPropertyBuilders implementation.
BeanAliasMap	getAliases()
Collection<? extends WritableProperty<?>>	getProperties()
WritableProperty<?>	getProperty(String name)
int	getPropertyCount()
final AbstractBean	getReadOnly()
boolean	isDynamic()
protected boolean	isLockOwnerInternal(AttributeReadOnly lock)
final boolean	isReadOnly()
protected boolean	isThreadSafe()
protected static boolean	isThreadSafe(AbstractBean bean)	Internal method to get access to isThreadSafe().
AbstractBean	newInstance()
protected void	onPropertyAdded(WritableProperty<?> property)
io.github.mmm.value.ReadablePath	parentPath()
void	parentPath(io.github.mmm.value.ReadablePath parent)
String	path(boolean fixed)
String	pathSegment()
void	pathSegment(String path)	Used to set an alias as described in WritableBean.pathSegment().
protected void	registerAlias(String propertyName, String alias)
protected void	registerAliases(String propertyName, String... propertyAliases)
protected void	requireDynamic()	Verifies that this Bean is dynamic (extensible).
protected void	requireWritable()	Verifies that this Bean is writable (not read-only).
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mmm.marshall.MarshallableObject

writeObject

Methods inherited from interface io.github.mmm.bean.ReadableBean

doEquals, doToString, get, getJavaClass, isEqual, isPolymorphic, isPrototype, mapPropertyIds, toString, validate

Methods inherited from interface io.github.mmm.value.ReadablePath

path, path

Methods inherited from interface io.github.mmm.marshall.UnmarshallableObject

readObject

Methods inherited from interface io.github.mmm.validation.Validatable

validateOrThrow

Methods inherited from interface io.github.mmm.bean.WritableBean

asTypeKey, defineIdMapping, getOrCreateProperty, getRequiredProperty, getType, read, set, set, setDynamic, write

Constructor Details

AbstractBean

public AbstractBean(WritableBean writable)

The constructor.

Parameters:

writable - the WritableBean to wrap as read-only bean or null to create a mutable bean.

Method Details

pathSegment

public String pathSegment()

Specified by:

pathSegment in interface io.github.mmm.value.ReadablePath

Specified by:

pathSegment in interface WritableBean

Returns:

the optional alias of this bean. It will be appended as prefix to the ReadablePath.path() of all properties. This is useful for API to build queries. So e.g. set to "alias" and your contained property will have the path "alias.MyProperty".

pathSegment

public void pathSegment(String path)

Description copied from interface: WritableBean

Used to set an alias as described in WritableBean.pathSegment(). ATTENTION: End users should never use this method directly but use designated methods such as as(String alias) provided by according SQL clauses.

Specified by:

pathSegment in interface WritableBean

Specified by:

pathSegment in interface io.github.mmm.value.WritablePath

parentPath

public io.github.mmm.value.ReadablePath parentPath()

Specified by:

parentPath in interface io.github.mmm.value.ReadablePath

parentPath

public void parentPath(io.github.mmm.value.ReadablePath parent)

Specified by:

parentPath in interface io.github.mmm.value.WritablePath

path

public String path(boolean fixed)

Specified by:

path in interface io.github.mmm.value.ReadablePath

isThreadSafe

protected boolean isThreadSafe()

Returns:

true if the Bean will be access concurrently and is required to be thread-safe (use concurrent collections, etc.), false otherwise. Please note we strongly encourage you not use Beans concurrently and overriding this method to return true. We also will not thoroughly test such concurrency and just support it as best-guess implementation since it is relatively easy for us but rather impossible to solve from the outside. So in case you are blocked by a concurrency issue that you do not want to solve otherwise, you may consider overriding this method to return true for your beans. Please also be warned that this causes quite some overhead and will reduce performance.

isDynamic

public boolean isDynamic()

Specified by:

isDynamic in interface ReadableBean

Returns:

true if this Bean is dynamic meaning that is not strictly typed but allows to dynamically add properties, false otherwise.

See Also:

• VirtualBean

requireWritable

protected void requireWritable()

Verifies that this Bean is writable (not read-only).

requireDynamic

protected void requireDynamic()

Verifies that this Bean is dynamic (extensible).

getReadOnly

public final AbstractBean getReadOnly()

Specified by:

getReadOnly in interface WritableBean

Returns:

the read only view on this bean.

See Also:

• AttributeReadOnly.isReadOnly()
• WritableBean.getReadOnly(WritableBean)

newInstance

public AbstractBean newInstance()

Specified by:

newInstance in interface ReadableBean

Returns:

a new instance of this WritableBean.

copy

public WritableBean copy()

Specified by:

copy in interface ReadableBean

Returns:

a copy of this WritableBean that has the same values for all properties.

isReadOnly

public final boolean isReadOnly()

Specified by:

isReadOnly in interface AttributeReadOnly

create

protected AbstractBean create(WritableBean writable)

Creates a new instance of this Bean implementation. The default implementation uses reflection. To improve performance please override this method. Please note, that if you do so, you also need to override this method again for all sub-classes of the hierarchy.

Parameters:

writable - the AdvancedBean to wrap as read-only bean or null to create a mutable bean.

Returns:

the new Bean instance. Has to be of the same type as the current class.

getProperties

public Collection<? extends WritableProperty<?>> getProperties()

Specified by:

getProperties in interface ReadableBean

Specified by:

getProperties in interface WritableBean

Returns:

a Collection with all properties of this bean.

getProperty

public WritableProperty<?> getProperty(String name)

Specified by:

getProperty in interface ReadableBean

Specified by:

getProperty in interface WritableBean

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.

See Also:

• WritableBean.addProperty(WritableProperty)
• WritableBean.getOrCreateProperty(String, Class)

getPropertyCount

public int getPropertyCount()

Specified by:

getPropertyCount in interface ReadableBean

Returns:

the number of properties of this ReadableBean.

createProperty

public <V> WritableProperty<V> createProperty(String name,
 Class<V> valueClass)

Description copied from interface: WritableBean

Creates and adds a WritableProperty with the given value class dynamically.

Specified by:

createProperty in interface WritableBean

Type Parameters:

V - the generic type of the value class.

Parameters:

name - the property name.

valueClass - the value class.

Returns:

the newly created and added property.

addProperty

public <P extends WritableProperty<?>> P addProperty(P property)

Description copied from interface: WritableBean

Adds the given WritableProperty to this bean.

Specified by:

addProperty in interface WritableBean

Type Parameters:

P - type of the WritableProperty to add.

Parameters:

property - the WritableProperty to add.

Returns:

the given property.

add

protected <V,
P extends WritableProperty<V>> P add(P property)

Internal method for addProperty(WritableProperty), without verification. Will be called from constructor of bean class implementations to register properties.

Type Parameters:

V - type of the property value.

P - type of the WritableProperty to add.

Parameters:

property - the WritableProperty to add.

Returns:

the given property.

isLockOwnerInternal

protected boolean isLockOwnerInternal(AttributeReadOnly lock)

Parameters:

lock - the lock to check.

Returns:

true if this bean is the lock owner, false otherwise.

add

protected PropertyBuilders add()

Returns:

the builder factory to build properties to be added to this bean.

createPropertyBuilders

protected StandardPropertyBuilders createPropertyBuilders()

Internal method that may be overridden to replace the StandardPropertyBuilders implementation.

Returns:

the StandardPropertyBuilders instance.

onPropertyAdded

protected void onPropertyAdded(WritableProperty<?> property)

Parameters:

property - the WritableProperty that has been added.

registerAlias

protected void registerAlias(String propertyName,
 String alias)

Parameters:

propertyName - the property name.

alias - the alias to add.

registerAliases

protected void registerAliases(String propertyName,
 String... propertyAliases)

Parameters:

propertyName - the property name.

propertyAliases - the aliases to add.

getAliases

public BeanAliasMap getAliases()

Specified by:

getAliases in interface ReadableBean

Returns:

the BeanAliasMap with potential aliases for property names.

toString

public String toString()

Overrides:

toString in class Object

isThreadSafe

protected static boolean isThreadSafe(AbstractBean bean)

Internal method to get access to isThreadSafe().

Parameters:

bean - the AbstractBean.

Returns:

the value of isThreadSafe().