org.beanio.internal.parser
Class CollectionBean

java.lang.Object
  org.beanio.internal.util.TreeNode<Component>
      org.beanio.internal.parser.Component
          org.beanio.internal.parser.PropertyComponent
              org.beanio.internal.parser.CollectionBean

All Implemented Interfaces:

Cloneable, Iterable<Component>, Property, Replicateable

public class CollectionBean
extends PropertyComponent
implements Property

A Property that stores children in a Collection.

If a child property is missing or null, null is added to the collection.

Since:

2.0

Author:

Kevin Seim

Field Summary

Fields inherited from class org.beanio.internal.parser.PropertyComponent

createMissingBeans

Fields inherited from interface org.beanio.internal.parser.Property

AGGREGATION_ARRAY, AGGREGATION_COLLECTION, AGGREGATION_MAP, COLLECTION, COMPLEX, MAP, SIMPLE

Constructor Summary

CollectionBean()
Constructs a new CollectionBean.

Method Summary

void	clearValue(ParsingContext context) Clears the property value.
Object	createValue(ParsingContext context) Creates the property value and returns it.
boolean	defines(Object value)
Object	getValue(ParsingContext context) Returns the value of this property.
protected Object	newInstance() Creates a new instance of this bean object.
void	registerLocals(Set<ParserLocal<? extends Object>> locals) Called by a stream to register variables stored in the parsing context.
void	setValue(ParsingContext context, Object value) Sets the property value (before marshalling).
int	type() Returns the property type.

Methods inherited from class org.beanio.internal.parser.PropertyComponent

getAccessor, getType, isIdentifier, isRequired, isSupportedChild, setAccessor, setIdentifier, setRequired, setType, toParamString

Methods inherited from class org.beanio.internal.util.TreeNode

add, clone, find, getChildren, getFirst, getName, iterator, print, setName, size, sort, toString, updateReferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.beanio.internal.parser.Property

getAccessor, getName, getType, isIdentifier, setAccessor, setIdentifier, setType

Constructor Detail

CollectionBean

public CollectionBean()

Constructs a new CollectionBean.

Method Detail

type

public int type()

Description copied from interface: Property

Returns the property type.

Specified by:

type in interface Property

Returns:

Property.SIMPLE, Property.COMPLEX, Property.AGGREGATION_ARRAY, Property.COLLECTION, Property.AGGREGATION_COLLECTION, or Property.MAP

clearValue

public void clearValue(ParsingContext context)

Description copied from interface: Property

Clears the property value. A subsequent call to Property.getValue(ParsingContext) should return null, or Value.MISSING for lazy property values.

Specified by:

clearValue in interface Property

Parameters:

context - the ParsingContext

createValue

public Object createValue(ParsingContext context)

Description copied from interface: Property

Creates the property value and returns it.

Specified by:

createValue in interface Property

Parameters:

context - the ParsingContext

Returns:

the property value

getValue

public Object getValue(ParsingContext context)

Description copied from interface: Property

Returns the value of this property.

When unmarshalling, this method should return Value.MISSING if the field was not present in the stream. Or if present, but has no value, null should be returned.

When marshalling, this method should return Value.MISSING for any optional segment bound to a bean object, or null if required. Null field properties should always return Value.MISSING.

Specified by:

getValue in interface Property

Parameters:

context - the ParsingContext

Returns:

the property value, or Value.MISSING if not present in the stream, or Value.INVALID if the field was invalid

setValue

public void setValue(ParsingContext context,
                     Object value)

Description copied from interface: Property

Sets the property value (before marshalling).

Specified by:

setValue in interface Property

Parameters:

context - the ParsingContext

value - the property value

defines

public boolean defines(Object value)

Specified by:

defines in interface Property

newInstance

protected Object newInstance()

Creates a new instance of this bean object.

Returns:

the new bean Object

registerLocals

public void registerLocals(Set<ParserLocal<? extends Object>> locals)

Description copied from class: Component

Called by a stream to register variables stored in the parsing context. This method should be overridden by subclasses that need to register one or more parser context variables.

Overrides:

registerLocals in class Component

Parameters:

locals - set of local variables