fr.paris.lutece.util
Class ReferenceList

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.ArrayList<ReferenceItem>
              extended by fr.paris.lutece.util.ReferenceList
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ReferenceItem>, java.util.Collection<ReferenceItem>, java.util.List<ReferenceItem>, java.util.RandomAccess

public class ReferenceList
extends java.util.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

Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
ReferenceList()
           
 
Method Summary
 void addItem(int nCode, java.lang.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(java.lang.String strCode, java.lang.String strName)
          This method adds a new element (code, name) to the list
 void checkItems(java.lang.String[] valuesToCheck)
          CheckItems when are selected
static ReferenceList convert(java.util.Collection collection, java.lang.String strCodeAttribute, java.lang.String strNameAttribute, boolean bNumericCode)
          Converts a collection to a ReferenceList
static ReferenceList convert(java.util.Map<java.lang.String,java.lang.String> map)
          Convert a Map into a ReferenceList
 java.util.Map<java.lang.String,java.lang.String> toMap()
          Convert the ReferenceList into a map
 
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeRange, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Constructor Detail

ReferenceList

public ReferenceList()
Method Detail

addItem

public void addItem(java.lang.String strCode,
                    java.lang.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,
                    java.lang.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(java.util.Collection collection,
                                    java.lang.String strCodeAttribute,
                                    java.lang.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(java.util.Map<java.lang.String,java.lang.String> map)
Convert a Map into a ReferenceList

Parameters:
map - the map to convert
Returns:
the converted ReferenceList

toMap

public java.util.Map<java.lang.String,java.lang.String> toMap()
Convert the ReferenceList into a map

Returns:
the converted map

checkItems

public void checkItems(java.lang.String[] valuesToCheck)
CheckItems when are selected

Parameters:
valuesToCheck - The list of string


Copyright © 2012 Mairie de Paris. All Rights Reserved.