com.opencsv.bean

Class PositionToBeanField<T>

java.lang.Object

com.opencsv.bean.AbstractFieldMapEntry<String,Integer,T>

com.opencsv.bean.PositionToBeanField<T>

Type Parameters:

T - Type of the bean being converted

All Implemented Interfaces:

ComplexFieldMapEntry<String,Integer,T>, Iterable<FieldMapByPositionEntry<T>>

public class PositionToBeanField<T>
extends AbstractFieldMapEntry<String,Integer,T>
implements Iterable<FieldMapByPositionEntry<T>>

Maps any column position matching a range definition to a BeanField.

Author:

Andrew Rucker Jones

Field Summary

Fields inherited from class com.opencsv.bean.AbstractFieldMapEntry

errorLocale, field

Constructor Summary

Constructors

Constructor and Description
PositionToBeanField(String rangeDefinition, int maxIndex, BeanField<T,Integer> field, Locale errorLocale) Initializes this mapping with a list of ranges and the associated BeanField.

Method Summary

Modifier and Type	Method and Description
void	attenuateRanges(int maxIndex) If there are ranges in the list of ranges encompassed by this mapping that stretch beyond the maximum index given, they are shortened to be no longer than the maximum index.
boolean	contains(Integer key) Determines whether or not the given key is contained in this entry.
String	getInitializer() Returns the information used to initialize this entry.
Iterator<FieldMapByPositionEntry<T>>	iterator()

Methods inherited from class com.opencsv.bean.AbstractFieldMapEntry

getBeanField, setErrorLocale

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PositionToBeanField

public PositionToBeanField(String rangeDefinition,
                           int maxIndex,
                           BeanField<T,Integer> field,
                           Locale errorLocale)

Initializes this mapping with a list of ranges and the associated BeanField.

Parameters:

rangeDefinition - A definition of ranges as documented in CsvBindAndJoinByPosition.position()

maxIndex - The maximum index allowed for a range. Ranges will be adjusted as documented in attenuateRanges(int).

field - The BeanField this mapping maps to

errorLocale - The locale for error messages

Throws:

CsvBadConverterException - If rangeDefinition cannot be parsed

Method Detail

attenuateRanges

public void attenuateRanges(int maxIndex)

If there are ranges in the list of ranges encompassed by this mapping that stretch beyond the maximum index given, they are shortened to be no longer than the maximum index. Ranges that lie completely beyond the maximum index are shortened to a one-element range consisting of the range's lower boundary. No ranges are under any circumstances removed, as this might compromise checks for required fields.

Parameters:

maxIndex - The new maximum for ranges

contains

public boolean contains(Integer key)

Description copied from interface: ComplexFieldMapEntry

Determines whether or not the given key is contained in this entry.

Specified by:

contains in interface ComplexFieldMapEntry<String,Integer,T>

Parameters:

key - The key to be located

Returns:

Whether key is represented by this entry

getInitializer

public String getInitializer()

Description copied from interface: ComplexFieldMapEntry

Returns the information used to initialize this entry. This information is not guaranteed to be exactly the same as the original value, but is functionally equivalent.

Specified by:

getInitializer in interface ComplexFieldMapEntry<String,Integer,T>

Returns:

The original information used to initialize this mapping entry

iterator

public Iterator<FieldMapByPositionEntry<T>> iterator()

Specified by:

iterator in interface Iterable<FieldMapByPositionEntry<T>>