net.sf.mmm.util.pojo.descriptor.base

Class AbstractPojoPropertyDescriptor

java.lang.Object

net.sf.mmm.util.pojo.descriptor.base.AbstractPojoPropertyDescriptor

All Implemented Interfaces:

PojoAttributeName, PojoPropertyDescriptor

Direct Known Subclasses:

PojoPropertyDescriptorImpl

public abstract class AbstractPojoPropertyDescriptor
extends Object
implements PojoPropertyDescriptor

This is the abstract base implementation of the PojoPropertyDescriptor interface.

Since:

1.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private Field	field
private String	name

Constructor Summary

Constructors

Constructor and Description
AbstractPojoPropertyDescriptor(String propertyName) The constructor.

Method Summary

Modifier and Type	Method and Description
Field	getField() This method returns the Field this descriptor represents or null if this descriptor does not represent any field.
String	getName() This method gets the programmatic (technical) name of the according property.
abstract PojoPropertyAccessor	putAccessor(PojoPropertyAccessor accessor) This method puts the given accessor into this property-descriptor.
void	setField(Field field) Sets the Field represented by this descriptor.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.pojo.descriptor.api.PojoPropertyDescriptor

getAccessor, getAccessors

Field Detail

name

private final String name

See Also:

getName()

field

private Field field

See Also:

getField()

Constructor Detail

AbstractPojoPropertyDescriptor

public AbstractPojoPropertyDescriptor(String propertyName)

The constructor.

Parameters:

propertyName - is the name of the property.

Method Detail

getName

public String getName()

This method gets the programmatic (technical) name of the according property.
E.g. for the read accessor public String getFooBar() the property name would be fooBar.

Specified by:

getName in interface PojoAttributeName

Returns:

the property name.

See Also:

PropertyDescriptor

getField

public Field getField()

This method returns the Field this descriptor represents or null if this descriptor does not represent any field.
ATTENTION:
PojoPropertyAccessor.getAccessibleObject() will return the accessible object for the according accessor. Depending on the introspection variant this will represent the actual method or field used to access the property. Therefore if you want to evaluate annotations of a property you should by default use PojoPropertyAccessor.getAccessibleObject() of the getter. However, if you are using method introspection and want to additionally access the field with the same property name if available in the Pojo then this method is the right one.

Specified by:

getField in interface PojoPropertyDescriptor

Returns:

the Field, which is part of this PojoPropertyDescriptor or null if this PojoPropertyDescriptor is not related to a Field

setField

public void setField(Field field)

Sets the Field represented by this descriptor. Necessary in case of field gets introspected after methods.

Parameters:

field - Field represented by this descriptor

putAccessor

public abstract PojoPropertyAccessor putAccessor(PojoPropertyAccessor accessor)

This method puts the given accessor into this property-descriptor.
ATTENTION:
This method may only be used during creation and initialization of this object. Be careful NOT to accidently replace existing accessors.

Parameters:

accessor - is the accessor to add.

Returns:

the PojoPropertyAccessor with the same mode as the given accessor that has been replaced by accessor or null if none has been replaced.

See Also:

PojoPropertyDescriptor.getAccessor(net.sf.mmm.util.pojo.descriptor.api.accessor.PojoPropertyAccessorMode)

toString

public String toString()

Overrides:

toString in class Object