org.openlowcode.tools.misc

Class NamedList<E extends NamedInterface>

java.lang.Object

org.openlowcode.tools.misc.NamedList<E>

public class NamedList<E extends NamedInterface>
extends java.lang.Object

A utility class to store objects identified by a unique name. This class offers both the capability to access the data as orderedlist, and to lookup the data by name.

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
NamedList() Creates a new empty NamedList

Method Summary

Modifier and Type	Method and Description
void	add(E element) adds the element if it does not exist yet, else throws an exception
boolean	addIfNew(E element) This method adds the element if it does not exist yet.
java.lang.String	dropNameList()
E	get(int index)
java.util.List<E>	getFullList()
int	getSize()
E	lookupOnName(java.lang.String name)
void	mergeWithNamedList(NamedList<E> otherlist) Merges two lists.
void	mergeWithNamedListIfNotExist(NamedList<E> otherlist) Merges with the current list, while removing duplicates.
<D extends Named> NamedList<D>	OneEltList(D singleelt) generates in one line a one element list.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedList

public NamedList()

Creates a new empty NamedList

Method Detail

getFullList

public java.util.List<E> getFullList()

dropNameList

public java.lang.String dropNameList()

Returns:

a string that will include all the names of the objects in the NamedList

lookupOnName

public E lookupOnName(java.lang.String name)

Parameters:

name - name to look at. The name should be the cleaned version

Returns:

the object if it exists, or null if no object with that name exists

getSize

public int getSize()

Returns:

the number of elements in the list

get

public E get(int index)

Parameters:

index - the index in the list, from 0 (included) to the list size (excluded)

Returns:

the object at the position. The object can be null

addIfNew

public boolean addIfNew(E element)

This method adds the element if it does not exist yet. Else, it executes gracefully without throwing an exception

Parameters:

element -

Returns:

true if the element was added, false else

add

public void add(E element)

adds the element if it does not exist yet, else throws an exception

Parameters:

element - the element to add

mergeWithNamedList

public void mergeWithNamedList(NamedList<E> otherlist)

Merges two lists. The operation will complete if the two lists have no conflicting elements. Else, an exception will be thrown at some point during the merge

Parameters:

otherlist - the list to merge with this one

mergeWithNamedListIfNotExist

public void mergeWithNamedListIfNotExist(NamedList<E> otherlist)

Merges with the current list, while removing duplicates. The elements kept are the one of the current list

Parameters:

otherlist - the list to merge with this one

OneEltList

public <D extends Named> NamedList<D> OneEltList(D singleelt)

generates in one line a one element list.

Parameters:

singleelt - the element

Returns:

a one element list with the element provided