org.beanio.builder

Class PropertyBuilderSupport<T extends PropertyBuilderSupport<T>>

java.lang.Object

org.beanio.builder.PropertyBuilderSupport<T>

Type Parameters:

T - the builder subclass

Direct Known Subclasses:

FieldBuilder, GroupBuilderSupport, SegmentBuilderSupport

public abstract class PropertyBuilderSupport<T extends PropertyBuilderSupport<T>>
extends Object

Support for property configuration builders.

Methods may throw a BeanIOConfigurationException if an invalid setting is configured.

Since:

2.1.0

Method Summary

Modifier and Type	Method and Description
T	collection(Class<?> type) Sets the collection type bound to this component.
protected abstract PropertyConfig	getConfig() Returns the configuration settings.
T	getter(String getter) Sets the getter method for getting this component from its parent.
T	lazy() Indicates this component should not be instantiated if this component or all of its children are null or the empty String.
T	maxOccurs(int max) Sets the maximum occurrences of this component.
protected abstract T	me() Returns this.
T	minOccurs(int min) Sets the minimum occurrences of this component.
T	occurs(int n) Sets the exact occurrences of this component.
T	occurs(int min, int max) Sets the minimum and maximum occurrences of this component.
T	setter(String setter) Sets the setter method for setting this component on its parent.
T	type(Class<?> type) Sets the class bound to this component.
T	xmlName(String xmlName) Sets the XML element or attribute name.
T	xmlNamespace(String xmlNamespace) Sets the XML namespace.
T	xmlPrefix(String xmlPrefix) Sets the XML namespace prefix.
T	xmlType(XmlType xmlType) Sets the XML type of this component.

Methods inherited from class java.lang.Object

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

Method Detail

me

protected abstract T me()

Returns this.

Returns:

this

getConfig

protected abstract PropertyConfig getConfig()

Returns the configuration settings.

Returns:

the configuration

minOccurs

public T minOccurs(int min)

Sets the minimum occurrences of this component.

Parameters:

min - the minimum occurrences

Returns:

this

maxOccurs

public T maxOccurs(int max)

Sets the maximum occurrences of this component.

Parameters:

max - the maximum occurrences

Returns:

this

occurs

public T occurs(int n)

Sets the exact occurrences of this component.

Parameters:

n - the number of occurrences

Returns:

this

occurs

public T occurs(int min,
                int max)

Sets the minimum and maximum occurrences of this component.

Parameters:

min - the minimum occurrences

max - the maximum occurrences or -1 for unbounded

Returns:

this

type

public T type(Class<?> type)

Sets the class bound to this component.

Parameters:

type - the class

Returns:

this

collection

public T collection(Class<?> type)

Sets the collection type bound to this component.

Parameters:

type - the Collection or Map class or subclass

Returns:

this

getter

public T getter(String getter)

Sets the getter method for getting this component from its parent.

Parameters:

getter - the getter method name

Returns:

this

setter

public T setter(String setter)

Sets the setter method for setting this component on its parent.

Parameters:

setter - the setter method name

Returns:

this

lazy

public T lazy()

Indicates this component should not be instantiated if this component or all of its children are null or the empty String.

Returns:

this

xmlType

public T xmlType(XmlType xmlType)

Sets the XML type of this component.

Parameters:

xmlType - the XmlType

Returns:

this

xmlPrefix

public T xmlPrefix(String xmlPrefix)

Sets the XML namespace prefix.

Parameters:

xmlPrefix - the prefix

Returns:

this

xmlName

public T xmlName(String xmlName)

Sets the XML element or attribute name.

Parameters:

xmlName - the name

Returns:

this

xmlNamespace

public T xmlNamespace(String xmlNamespace)

Sets the XML namespace.

Parameters:

xmlNamespace - the namespace

Returns:

this