net.sf.joafip.java.util.support

Interface IListSupport<E>

Type Parameters:

E - the list element type

All Superinterfaces:

ISupportListenable<E>, Iterable<E>

All Known Implementing Classes:

ArrayListSupport, LinkedHashSupport, LinkedListSupport, LinkedTreeSupport, TreeListSupport

public interface IListSupport<E>
extends Iterable<E>, ISupportListenable<E>

interface for support of minimum for list management
facility for set, see addReplace(Object)

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
E	add(int index, E element) add element at index position
E	addAtBegin(E element)
E	addAtEnd(E element) add element at end of the list
E	addReplace(E element) add element at end of the list if equals element not already in the list, else replace the equals element
void	clear() clear the list
boolean	contains(Object object) to know if list contains an element equals to an object equality check is done using Object.equals element implementation
ListIterator<E>	descendingIterator() Returns an iterator over the elements in this list in reverse sequential order.
E	get(int index)
E	get(Object object) search for an element and return founded if one
E	getFirst() get the first element of the list null returned if empty list or if first element is null
E	getLast() get the last element of the list null returned if empty list or if last element is null
int	getSize()
int	indexOf(Object object)
boolean	isEmpty()
ListIterator<E>	iterator() next will return the first element if list not empty no previous element
ListIterator<E>	iterator(int index) next will return element at index position
int	lastIndexOf(Object object)
E	remove(E element) remove element
E	remove(int index) remove element at index
E	removeFirst() remove first element of the list
E	removeLast() remove last element of the list
E	set(E element, int index) add element at position

Methods inherited from interface net.sf.joafip.java.util.support.ISupportListenable

removeListener, setListener

Method Detail

set

E set(E element,
    int index)

add element at position

Parameters:

element -

index -

resize - true if allow list resising

Returns:

instance of the element replaced, null if none

Throws:

IndexOutOfBoundsException - position is out of list

addAtEnd

E addAtEnd(E element)

add element at end of the list

Parameters:

element - the element to add

Returns:

the replaced element, null if none

addAtBegin

E addAtBegin(E element)

Parameters:

element - element to add at begin of list

Returns:

replaced element, null if none

add

E add(int index,
    E element)

add element at index position

Parameters:

index - position for add

element - element to add

Returns:

replaced element, null if none

addReplace

E addReplace(E element)

add element at end of the list if equals element not already in the list, else replace the equals element

remove

E remove(E element)

remove element

Parameters:

element - the element to remove

Returns:

the removed element, null if none

remove

E remove(int index)

remove element at index

Parameters:

index - position of element to remove

Returns:

the removed element

removeFirst

E removeFirst()

remove first element of the list

Returns:

element removed, null if element removed was null or if empty list

removeLast

E removeLast()

remove last element of the list

Returns:

element removed, null if element removed was null or if empty list

getFirst

E getFirst()

get the first element of the list
null returned if empty list or if first element is null

Returns:

first element of the list

getLast

E getLast()

get the last element of the list
null returned if empty list or if last element is null

Returns:

first element of the list

indexOf

int indexOf(Object object)

Parameters:

object -

Returns:

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

lastIndexOf

int lastIndexOf(Object object)

Parameters:

object -

Returns:

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

get

E get(Object object)

search for an element and return founded if one

Parameters:

object - the element to search for

Returns:

the found element or null if none found

get

E get(int index)

Parameters:

index -

Returns:

element at position index

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( index < 0 || index >= size()).

contains

boolean contains(Object object)

to know if list contains an element equals to an object
equality check is done using Object.equals element implementation

Parameters:

object - the element to search for

Returns:

true if element found

clear

void clear()

clear the list

getSize

int getSize()

Returns:

number of elements in the list

isEmpty

boolean isEmpty()

Returns:

true if list empty

iterator

ListIterator<E> iterator()

next will return the first element if list not empty
no previous element

Specified by:

iterator in interface Iterable<E>

Returns:

iterator on this list, set to start at begin of this list

iterator

ListIterator<E> iterator(int index)

next will return element at index position

Parameters:

index - start of the iteration

Returns:

iterator on this list, set to start at index element

descendingIterator

ListIterator<E> descendingIterator()

Returns an iterator over the elements in this list in reverse sequential order. The elements will be returned in order from last (tail) to first (head).

Returns:

an iterator over the elements in this list in reverse sequence