org.apache.cayenne.reflect

Interface PropertyDescriptor

All Superinterfaces:

Property

All Known Subinterfaces:

ArcProperty, AttributeProperty, ToManyMapProperty, ToManyProperty, ToOneProperty

All Known Implementing Classes:

BaseArcProperty, BaseProperty, BaseToManyProperty, BaseToOneProperty, SimpleAttributeProperty

public interface PropertyDescriptor
extends Property

Defines bean property API used by Cayenne to access object data, do faulting and graph maintenance tasks.

Since:

4.0

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns property name.
void	injectValueHolder(Object object) If a property is implemented as a ValueHolder, this operation would create an unfaulted value holder and inject it into the object, if an object doesn't have it set yet.
Object	readProperty(Object object) Returns a property value, inflating unresolved object if need.
Object	readPropertyDirectly(Object object) Returns a property value of an object without disturbing the object fault status.
boolean	visit(PropertyVisitor visitor) A visitor accept method.
void	writeProperty(Object object, Object oldValue, Object newValue) Sets a property value, inflating unresolved object if need.
void	writePropertyDirectly(Object object, Object oldValue, Object newValue) Sets a property value of an object without disturbing the object fault status.

Method Detail

getName

String getName()

Returns property name.

Specified by:

getName in interface Property

readPropertyDirectly

Object readPropertyDirectly(Object object)
                            throws PropertyException

Returns a property value of an object without disturbing the object fault status.

Specified by:

readPropertyDirectly in interface Property

Throws:

PropertyException

readProperty

Object readProperty(Object object)
                    throws PropertyException

Returns a property value, inflating unresolved object if need.

Specified by:

readProperty in interface Property

Throws:

PropertyException

writePropertyDirectly

void writePropertyDirectly(Object object,
                         Object oldValue,
                         Object newValue)
                           throws PropertyException

Sets a property value of an object without disturbing the object fault status. Old value of the property is specified as a hint and can be ignored by the property implementor.

Specified by:

writePropertyDirectly in interface Property

Throws:

PropertyException

writeProperty

void writeProperty(Object object,
                 Object oldValue,
                 Object newValue)
                   throws PropertyException

Sets a property value, inflating unresolved object if need. Old value of the property is specified as a hint and can be ignored by the property implementor.

Specified by:

writeProperty in interface Property

Throws:

PropertyException

visit

boolean visit(PropertyVisitor visitor)

A visitor accept method.

Specified by:

visit in interface Property

Returns:

a status returned by the corresponding callback method of the visitor. It serves as an indication of whether peer properties processing is still needed.

injectValueHolder

void injectValueHolder(Object object)
                       throws PropertyException

If a property is implemented as a ValueHolder, this operation would create an unfaulted value holder and inject it into the object, if an object doesn't have it set yet.

Specified by:

injectValueHolder in interface Property

Throws:

PropertyException