com.opencsv.bean

Class AbstractFieldMap<I,K extends Comparable<K>,C extends ComplexFieldMapEntry<I,K,T>,T>

java.lang.Object

com.opencsv.bean.AbstractFieldMap<I,K,C,T>

Type Parameters:

I - The initializer type used to build the many-to-one mapping

K - Type of the field identifier (key)

C - Type of the ComplexFieldMapEntry used

T - Type of the bean being converted

All Implemented Interfaces:

FieldMap<I,K,C,T>

Direct Known Subclasses:

FieldMapByName, FieldMapByPosition

public abstract class AbstractFieldMap<I,K extends Comparable<K>,C extends ComplexFieldMapEntry<I,K,T>,T>
extends Object
implements FieldMap<I,K,C,T>

A base class to collect all generalized components of a FieldMap. May be used by all as a base class for their own implementations of FieldMap.

Since:

4.2

Author:

Andrew Rucker Jones

Field Summary

Fields

Modifier and Type	Field and Description
protected List<C>	complexMapList A list of entries representing all complex, that is many-to-one, mappings represented in this FieldMap.
protected Locale	errorLocale The locale for error messages.
protected SortedMap<K,BeanField<T,K>>	simpleMap A map for all simple, that is one-to-one, mappings represented in this FieldMap.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFieldMap(Locale errorLocale) Initializes this FieldMap.

Method Summary

Modifier and Type	Method and Description
BeanField<T,K>	get(K key) Gets the BeanField associated with this key.
BeanField<T,K>	put(K key, BeanField<T,K> value) Associates the given BeanField with the given key.
void	setErrorLocale(Locale errorLocale) Sets the locale to be used for error messages.
Collection<BeanField<T,K>>	values() Provides all values currently in the map.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opencsv.bean.FieldMap

generateHeader, putComplex

Field Detail

errorLocale

protected Locale errorLocale

The locale for error messages.

simpleMap

protected final SortedMap<K extends Comparable<K>,BeanField<T,K extends Comparable<K>>> simpleMap

A map for all simple, that is one-to-one, mappings represented in this FieldMap.

complexMapList

protected final List<C extends ComplexFieldMapEntry<I,K,T>> complexMapList

A list of entries representing all complex, that is many-to-one, mappings represented in this FieldMap.

Constructor Detail

AbstractFieldMap

protected AbstractFieldMap(Locale errorLocale)

Initializes this FieldMap.

Parameters:

errorLocale - The locale to be used for error messages

Method Detail

get

public BeanField<T,K> get(K key)

Description copied from interface: FieldMap

Gets the BeanField associated with this key. If a key could possibly match both a regular, simple key (one added with FieldMap.put(Comparable, BeanField)), and a complex key (one added with FieldMap.putComplex(java.lang.Object, com.opencsv.bean.BeanField)), the simple key is always matched. If a key could match more than one complex key, the return value is undefined.

Specified by:

get in interface FieldMap<I,K extends Comparable<K>,C extends ComplexFieldMapEntry<I,K,T>,T>

Parameters:

key - The key under which to search for a BeanField

Returns:

The BeanField found, or null if none is present

put

public BeanField<T,K> put(K key,
                          BeanField<T,K> value)

Description copied from interface: FieldMap

Associates the given BeanField with the given key.

Specified by:

put in interface FieldMap<I,K extends Comparable<K>,C extends ComplexFieldMapEntry<I,K,T>,T>

Parameters:

key - The key under which to index the provided BeanField

value - The BeanField to be indexed

Returns:

If there was a value previously associated with this key, it is returned

values

public Collection<BeanField<T,K>> values()

Description copied from interface: FieldMap

Provides all values currently in the map.

Specified by:

values in interface FieldMap<I,K extends Comparable<K>,C extends ComplexFieldMapEntry<I,K,T>,T>

Returns:

The values in the map

setErrorLocale

public void setErrorLocale(Locale errorLocale)

Description copied from interface: FieldMap

Sets the locale to be used for error messages.

Specified by:

setErrorLocale in interface FieldMap<I,K extends Comparable<K>,C extends ComplexFieldMapEntry<I,K,T>,T>

Parameters:

errorLocale - The locale to be used for error messages