org.beanio.config
Class BeanPropertyConfig

java.lang.Object
  org.beanio.config.PropertyConfig
      org.beanio.config.BeanPropertyConfig

public class BeanPropertyConfig
extends PropertyConfig

A bean property can be added to a BeanConfig to set a property value on the bean object that is not found in the input stream. A bean property can also be used to identify the record mapping for marshalling a bean object by setting rid to true.

The following properties inherited from PropertyConfig are ignored:

• ignored
• collection
• minOccurs
• maxOccurs
• xmlName
• xmlType
• xmlNamespace
• xmlPrefix
• nillable
• xmlWrapper

Since:

1.2

Author:

Kevin Seim

Field Summary

Fields inherited from class org.beanio.config.PropertyConfig

LEFT, RIGHT

Constructor Summary

BeanPropertyConfig()
Constructs a new BeanPropertyConfig.

Method Summary

String	getFormat() Returns the format pattern used by date and number type handlers.
String	getTypeHandler() Returns the name of the custom type handler used to convert the property value to a Java object, or null if the default type handler is sufficient.
String	getValue() Returns the textual representation of the fixed property value.
boolean	isRecordIdentifier() Returns true if this property is used to identify the record mapping for marshalling a bean object when writing to an output stream.
void	setFormat(String format) Sets the format pattern used by date and number type handlers.
void	setRecordIdentifier(boolean recordIdentifier) Set to true if this property is used to identify the record mapping for marshalling a bean object when writing to an output stream.
void	setTypeHandler(String handler) Sets the name of the custom type handler to use to convert the property value to a Java object.
void	setValue(String value) Sets the textual representation of the fixed property value.

Methods inherited from class org.beanio.config.PropertyConfig

getCollection, getGetter, getMaxOccurs, getMinOccurs, getName, getSetter, getType, getXmlName, getXmlNamespace, getXmlPrefix, getXmlType, getXmlWrapper, isBean, isField, isIgnored, isNillable, setCollection, setGetter, setIgnored, setMaxOccurs, setMinOccurs, setName, setNillable, setSetter, setType, setXmlName, setXmlNamespace, setXmlPrefix, setXmlType, setXmlWrapper

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanPropertyConfig

public BeanPropertyConfig()

Constructs a new BeanPropertyConfig.

Method Detail

getValue

public String getValue()

Returns the textual representation of the fixed property value.

Returns:

the property value text

setValue

public void setValue(String value)

Sets the textual representation of the fixed property value.

Parameters:

value - the property value text

getTypeHandler

public String getTypeHandler()

Returns the name of the custom type handler used to convert the property value to a Java object, or null if the default type handler is sufficient.

Returns:

the name of the custom type handler

setTypeHandler

public void setTypeHandler(String handler)

Sets the name of the custom type handler to use to convert the property value to a Java object. Set to null if the default type handler is sufficient.

Parameters:

handler - the name of the custom type handler

isRecordIdentifier

public boolean isRecordIdentifier()

Returns true if this property is used to identify the record mapping for marshalling a bean object when writing to an output stream.

Returns:

true if this property is used to identify the record mapping during marshalling

setRecordIdentifier

public void setRecordIdentifier(boolean recordIdentifier)

Set to true if this property is used to identify the record mapping for marshalling a bean object when writing to an output stream.

Parameters:

recordIdentifier - true if this property is used to identify the record mapping during marshalling

getFormat

public String getFormat()

Returns the format pattern used by date and number type handlers.

Returns:

the date or number format pattern

setFormat

public void setFormat(String format)

Sets the format pattern used by date and number type handlers.

Parameters:

format - the date or number format pattern