public abstract class

Descriptor

extends Object
java.lang.Object
   ↳ org.apache.commons.betwixt.Descriptor
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Describes a content node mapping.

Common superclass for types of Descriptor

Summary

Public Constructors
Descriptor()
Base constructor
Public Methods
Options getOptions()
Gets the options for this descriptor.
String getPropertyName()
Gets the name of the bean property to which this node refers
Class getPropertyType()
Gets the type of the bean property associated with this node, if any
Class getSingularPropertyType()
Gets the underlying type ignoring any wrapping a Collection or Array.
Expression getTextExpression()
Gets the expression used to evaluate the text value of this node for a particular Context.
Updater getUpdater()
Gets the Updater used to update a Context from the text value corresponding to this node in an xml document
void setOptions(Options options)
Sets the options for this descriptor.
void setPropertyName(String propertyName)
Sets the name of the bean property to which this node refers
void setPropertyType(Class propertyType)
Sets the type of the bean property associated with this node, if any
void setSingularPropertyType(Class singularPropertyType)
Sets the underlying type ignoring any wrapping Collection or Array.
void setTextExpression(Expression textExpression)
Sets the expression used to evaluate the text value of this node for a particular Context
void setUpdater(Updater updater)
Sets the Updater used to update a Context from the text value corresponding to this node in an xml document
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Descriptor ()

Base constructor

Public Methods

public Options getOptions ()

Gets the options for this descriptor. Options are used to communicate non-declarative (optinal) behaviour hints.

Returns
  • Options, not null

public String getPropertyName ()

Gets the name of the bean property to which this node refers

Returns
  • the name of the bean property to which this node refers to, or null if it is just a constant

public Class getPropertyType ()

Gets the type of the bean property associated with this node, if any

Returns
  • the property type associated with this node, if any

public Class getSingularPropertyType ()

Gets the underlying type ignoring any wrapping a Collection or Array.

Returns
  • if this property is a 1-N relationship then this returns the type of a single property value.

public Expression getTextExpression ()

Gets the expression used to evaluate the text value of this node for a particular Context.

Returns
  • the expression used to evaluate the text value of this node

public Updater getUpdater ()

Gets the Updater used to update a Context from the text value corresponding to this node in an xml document

Returns
  • the Update that should be used to update the value of this node

public void setOptions (Options options)

Sets the options for this descriptor. Options are used to communicate non-declarative (optinal) behaviour hints.

public void setPropertyName (String propertyName)

Sets the name of the bean property to which this node refers

Parameters
propertyName the name of the bean property. Or null, if this node is not mapped to to a bean property

public void setPropertyType (Class propertyType)

Sets the type of the bean property associated with this node, if any

Parameters
propertyType the Class of the bean property

public void setSingularPropertyType (Class singularPropertyType)

Sets the underlying type ignoring any wrapping Collection or Array.

Parameters
singularPropertyType the Class of the items in the Collection or Array. If node is associated with a collective bean property, then this should not be null.

public void setTextExpression (Expression textExpression)

Sets the expression used to evaluate the text value of this node for a particular Context

Parameters
textExpression the Expression to be used to evaluate the value of this node

public void setUpdater (Updater updater)

Sets the Updater used to update a Context from the text value corresponding to this node in an xml document

Parameters
updater the Updater to be used to update the values of this node