fr.paris.lutece.util

Class ReferenceList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<ReferenceItem>

fr.paris.lutece.util.ReferenceList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<ReferenceItem>, Collection<ReferenceItem>, List<ReferenceItem>, RandomAccess

public class ReferenceList
extends ArrayList<ReferenceItem>

This class provides the structure for a list of references values Each element includes a code and a name

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReferenceList() Default constructor.
ReferenceList(int nInitialCapacity) Creates a new reference list with a specified initial capacity.

Method Summary

Modifier and Type	Method and Description
void	addItem(int nCode, String strName) This method converts the int code specified in parameter as a String and adds a new element (code, name) to the list
void	addItem(String strCode, String strName) This method adds a new element (code, name) to the list
void	checkItems(String[] valuesToCheck) CheckItems when are selected
static ReferenceList	convert(Collection collection, String strCodeAttribute, String strNameAttribute, boolean bNumericCode) Converts a collection to a ReferenceList
static ReferenceList	convert(Map<String,String> map) Convert a Map<String, String> into a ReferenceList
Map<String,String>	toMap() Convert the ReferenceList into a map

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ReferenceList

public ReferenceList()

Default constructor.

ReferenceList

public ReferenceList(int nInitialCapacity)

Creates a new reference list with a specified initial capacity.

Parameters:

nInitialCapacity - The initial capacity of the collection

Method Detail

addItem

public void addItem(String strCode,
                    String strName)

This method adds a new element (code, name) to the list

Parameters:

strCode - The code as a String

strName - The name corresponding to the code as a String

addItem

public void addItem(int nCode,
                    String strName)

This method converts the int code specified in parameter as a String and adds a new element (code, name) to the list

Parameters:

nCode - The code to convert an add

strName - The name corresponding to the code as a String

convert

public static ReferenceList convert(Collection collection,
                                    String strCodeAttribute,
                                    String strNameAttribute,
                                    boolean bNumericCode)

Converts a collection to a ReferenceList

Parameters:

collection - The collection to convert

strCodeAttribute - The name of the code attribute. Ex : "id" to call getId()

strNameAttribute - The name of the code attribute. Ex : "name" to call getName()

bNumericCode - true if the code getter returns an Integer, false otherwise

Returns:

The ReferenceList filled

Since:

v1.1

convert

public static ReferenceList convert(Map<String,String> map)

Convert a Map<String, String> into a ReferenceList

Parameters:

map - the map to convert

Returns:

the converted ReferenceList

toMap

public Map<String,String> toMap()

Convert the ReferenceList into a map

Returns:

the converted map

checkItems

public void checkItems(String[] valuesToCheck)

CheckItems when are selected

Parameters:

valuesToCheck - The list of string