org.beanio.builder

Class SegmentBuilder

java.lang.Object

org.beanio.builder.PropertyBuilderSupport<T>

org.beanio.builder.SegmentBuilderSupport<SegmentBuilder>

org.beanio.builder.SegmentBuilder

public class SegmentBuilder
extends SegmentBuilderSupport<SegmentBuilder>

Builds a new segment configuration.

Since:

2.1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected SegmentConfig	config

Constructor Summary

Constructors

Constructor and Description
SegmentBuilder(String name)

Method Summary

Modifier and Type	Method and Description
SegmentConfig	build() Builds the segment configuration.
protected SegmentConfig	getConfig() Returns the configuration settings.
protected SegmentBuilder	me() Returns this.
SegmentBuilder	nillable() Indicates the XML element is nillable.
SegmentBuilder	occursRef(String ref) Indicates the number of occurrences of this segment is governed by another field.

Methods inherited from class org.beanio.builder.SegmentBuilderSupport

addField, addSegment, key, value

Methods inherited from class org.beanio.builder.PropertyBuilderSupport

collection, getter, lazy, maxOccurs, minOccurs, occurs, occurs, setter, type, xmlName, xmlNamespace, xmlPrefix, xmlType

Methods inherited from class java.lang.Object

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

Field Detail

config

protected SegmentConfig config

Constructor Detail

SegmentBuilder

public SegmentBuilder(String name)

Method Detail

getConfig

protected SegmentConfig getConfig()

Description copied from class: PropertyBuilderSupport

Returns the configuration settings.

Specified by:

getConfig in class SegmentBuilderSupport<SegmentBuilder>

Returns:

the configuration

me

protected SegmentBuilder me()

Description copied from class: PropertyBuilderSupport

Returns this.

Specified by:

me in class PropertyBuilderSupport<SegmentBuilder>

Returns:

this

occursRef

public SegmentBuilder occursRef(String ref)

Indicates the number of occurrences of this segment is governed by another field.

Parameters:

ref - the name of the field that governs the occurrences of this segment

Returns:

this

nillable

public SegmentBuilder nillable()

Indicates the XML element is nillable.

Returns:

this

build

public SegmentConfig build()

Builds the segment configuration.

Returns:

the segment configuration