PLinkedHashSet (JOAFIP "Abstract" Parent Project 4.0.0b9)

java.lang.Object
- net.sf.joafip.java.util.PAbstractCollection<E>
- - net.sf.joafip.java.util.PAbstractSet<E>
  - - net.sf.joafip.java.util.AbstractPSet<E>
    - - net.sf.joafip.java.util.PLinkedHashSet<E>

Type Parameters:
E -

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, Deque<E>, List<E>, Queue<E>, Set<E>, ICollectionListenable<E>, IPSet<E>, ISupportListener<E>
```
@StoreNotUseStandardSerialization
@StorableClass
public class PLinkedHashSet<E>
extends AbstractPSet<E>
implements Set<E>, Deque<E>, List<E>, Cloneable, Serializable
```
alternative implementation of LinkedHashSet pour file persistence

Author:

luc peuvrier

See Also:
Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PLinkedHashSet()`
	`PLinkedHashSet(IEqualsHashComparator comparator)`
`protected`	`PLinkedHashSet(IInstanceFactory instanceFactory)`
`protected`	`PLinkedHashSet(IInstanceFactory instanceFactory, IEqualsHashComparator comparator)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(E element)` return false if already contains same value object
`void`	`add(int index, E element)`
`boolean`	`addAll(int index, Collection<? extends E> collection)`
`void`	`addFirst(E element)`
`void`	`addLast(E element)`
`void`	`addListerner(ICollectionListener<E> listener)`
`E`	`addOrReplaceToEnd(E element)` add or replace an element, element is added or moved to end
`void`	`clear()`
`protected PLinkedHashSet<E>`	`clone()`
`boolean`	`contains(Object object)`
`Iterator<E>`	`descendingIterator()`
`E`	`element()`
`E`	`get(int index)`
`E`	`get(Object object)` get the real instance of object equals to reference object
`E`	`getFirst()`
`E`	`getLast()`
`LinkedHashSupport<E>`	`getLinkedHashSupport()`
`int`	`hashCode()`
`int`	`indexOf(Object object)`
`Iterator<E>`	`iterator()`
`int`	`lastIndexOf(Object object)`
`ListIterator<E>`	`listIterator()`
`ListIterator<E>`	`listIterator(int index)`
`boolean`	`moveDown(E element)`
`boolean`	`moveToFirstPosition(E element)` move element at begin of the list
`boolean`	`moveToLastPosition(E element)` move element at end of the list
`static PLinkedHashSet`	`newInstance(IInstanceFactory instanceFactory)`
`static PLinkedHashSet`	`newInstance(IInstanceFactory instanceFactory, IEqualsHashComparator comparator)`
`void`	`notifyAdded(E added)`
`void`	`notifyRemoved(E removed)`
`boolean`	`offer(E element)`
`boolean`	`offerFirst(E element)`
`boolean`	`offerLast(E element)`
`E`	`peek()`
`E`	`peekFirst()`
`E`	`peekLast()`
`E`	`poll()`
`E`	`pollFirst()`
`E`	`pollLast()`
`E`	`pop()`
`void`	`push(E element)`
`E`	`remove()`
`E`	`remove(int index)`
`boolean`	`remove(Object object)`
`E`	`removeFirst()`
`boolean`	`removeFirstOccurrence(Object object)`
`E`	`removeGetRemoved(Object object)` remove an element and return it
`E`	`removeLast()`
`boolean`	`removeLastOccurrence(Object object)`
`void`	`removeListener(int listenerIdentifier)`
`E`	`set(int index, E element)`
`void`	`setLinkedHashSupport(LinkedHashSupport<E> linkedHashSupport)`
`int`	`size()`
`List<E>`	`subList(int fromIndex, int toIndex)`

Methods inherited from class net.sf.joafip.java.util.PAbstractSet
equals, removeAll

Methods inherited from class net.sf.joafip.java.util.PAbstractCollection
addAll, containsAll, isEmpty, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set
addAll, containsAll, equals, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.List
addAll, containsAll, equals, isEmpty, removeAll, retainAll, toArray, toArray

- Constructor Detail
  - PLinkedHashSet
```
public PLinkedHashSet()
```
  - PLinkedHashSet
```
protected PLinkedHashSet(IInstanceFactory instanceFactory)
```
  - PLinkedHashSet
```
public PLinkedHashSet(IEqualsHashComparator comparator)
```
  - PLinkedHashSet
```
protected PLinkedHashSet(IInstanceFactory instanceFactory,
              IEqualsHashComparator comparator)
```
- Method Detail
  - newInstance
```
public static PLinkedHashSet newInstance(IInstanceFactory instanceFactory)
```
  - newInstance
```
public static PLinkedHashSet newInstance(IInstanceFactory instanceFactory,
                         IEqualsHashComparator comparator)
```
  - addListerner
```
public void addListerner(ICollectionListener<E> listener)
```
    Specified by:
    
    addListerner in interface ICollectionListenable<E>
  - removeListener
```
public void removeListener(int listenerIdentifier)
```
    Specified by:
    
    removeListener in interface ICollectionListenable<E>
  - notifyAdded
```
public void notifyAdded(E added)
```
    Specified by:
    
    notifyAdded in interface ISupportListener<E>
  - notifyRemoved
```
public void notifyRemoved(E removed)
```
    Specified by:
    
    notifyRemoved in interface ISupportListener<E>
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface Deque<E>
    
    Specified by:
    
    iterator in interface List<E>
    
    Specified by:
    
    iterator in interface Set<E>
  - listIterator
```
public ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<E>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface Deque<E>
    
    Specified by:
    
    size in interface List<E>
    
    Specified by:
    
    size in interface Set<E>
  - contains
```
public boolean contains(Object object)
```
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface Deque<E>
    
    Specified by:
    
    contains in interface List<E>
    
    Specified by:
    
    contains in interface Set<E>
    
    Overrides:
    
    contains in class PAbstractCollection<E>
  - get
```
public E get(Object object)
```
    Description copied from interface: IPSet
    
    get the real instance of object equals to reference object
    
    Specified by:
    
    get in interface IPSet<E>
    
    Specified by:
    
    get in class AbstractPSet<E>
    
    Parameters:
    object - reference object for search
    
    Returns:
    the real instance of object equals to reference object
  - add
```
public boolean add(E element)
```
    return false if already contains same value object
    
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface Deque<E>
    
    Specified by:
    
    add in interface List<E>
    
    Specified by:
    
    add in interface Queue<E>
    
    Specified by:
    
    add in interface Set<E>
  - add
```
public void add(int index,
       E element)
```
    Specified by:
    
    add in interface List<E>
  - addOrReplaceToEnd
```
public E addOrReplaceToEnd(E element)
```
    add or replace an element, element is added or moved to end
    
    Parameters:
    element - the element to add or use for replacemnent
    
    Returns:
    the replaced element, null if node
  - remove
```
public boolean remove(Object object)
```
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface Deque<E>
    
    Specified by:
    
    remove in interface List<E>
    
    Specified by:
    
    remove in interface Set<E>
    
    Overrides:
    
    remove in class PAbstractCollection<E>
  - removeGetRemoved
```
public E removeGetRemoved(Object object)
```
    remove an element and return it
    
    Parameters:
    object - the reference for search
    
    Returns:
    the removed element, or null if none
  - getLast
```
public E getLast()
```
    Specified by:
    
    getLast in interface Deque<E>
  - removeLast
```
public E removeLast()
```
    Specified by:
    
    removeLast in interface Deque<E>
  - getFirst
```
public E getFirst()
```
    Specified by:
    
    getFirst in interface Deque<E>
  - removeFirst
```
public E removeFirst()
```
    Specified by:
    
    removeFirst in interface Deque<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface List<E>
    
    Specified by:
    
    clear in interface Set<E>
    
    Overrides:
    
    clear in class PAbstractCollection<E>
  - clone
```
protected PLinkedHashSet<E> clone()
```
    Overrides:
    
    clone in class Object
  - moveToLastPosition
```
public boolean moveToLastPosition(E element)
```
    move element at end of the list
    
    Parameters:
    element -
    
    Returns:
  - moveDown
```
public boolean moveDown(E element)
```
    Parameters:
    element -
    
    Returns:
    true if move down, false if not found or already at end of the list
  - moveToFirstPosition
```
public boolean moveToFirstPosition(E element)
```
    move element at begin of the list
    
    Parameters:
    element -
    
    Returns:
  - setLinkedHashSupport
```
public void setLinkedHashSupport(LinkedHashSupport<E> linkedHashSupport)
```
  - getLinkedHashSupport
```
public LinkedHashSupport<E> getLinkedHashSupport()
```
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<E>
    
    Specified by:
    
    hashCode in interface List<E>
    
    Specified by:
    
    hashCode in interface Set<E>
    
    Overrides:
    
    hashCode in class PAbstractSet<E>
  - addAll
```
public boolean addAll(int index,
             Collection<? extends E> collection)
```
    Specified by:
    
    addAll in interface List<E>
  - get
```
public E get(int index)
```
    Specified by:
    
    get in interface List<E>
  - indexOf
```
public int indexOf(Object object)
```
    Specified by:
    
    indexOf in interface List<E>
  - lastIndexOf
```
public int lastIndexOf(Object object)
```
    Specified by:
    
    lastIndexOf in interface List<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface List<E>
  - set
```
public E set(int index,
    E element)
```
    Specified by:
    
    set in interface List<E>
  - subList
```
public List<E> subList(int fromIndex,
              int toIndex)
```
    Specified by:
    
    subList in interface List<E>
  - addFirst
```
public void addFirst(E element)
```
    Specified by:
    
    addFirst in interface Deque<E>
  - addLast
```
public void addLast(E element)
```
    Specified by:
    
    addLast in interface Deque<E>
  - descendingIterator
```
public Iterator<E> descendingIterator()
```
    Specified by:
    
    descendingIterator in interface Deque<E>
  - element
```
public E element()
```
    Specified by:
    
    element in interface Deque<E>
    
    Specified by:
    
    element in interface Queue<E>
  - offer
```
public boolean offer(E element)
```
    Specified by:
    
    offer in interface Deque<E>
    
    Specified by:
    
    offer in interface Queue<E>
  - offerFirst
```
public boolean offerFirst(E element)
```
    Specified by:
    
    offerFirst in interface Deque<E>
  - offerLast
```
public boolean offerLast(E element)
```
    Specified by:
    
    offerLast in interface Deque<E>
  - peek
```
public E peek()
```
    Specified by:
    
    peek in interface Deque<E>
    
    Specified by:
    
    peek in interface Queue<E>
  - peekFirst
```
public E peekFirst()
```
    Specified by:
    
    peekFirst in interface Deque<E>
  - peekLast
```
public E peekLast()
```
    Specified by:
    
    peekLast in interface Deque<E>
  - poll
```
public E poll()
```
    Specified by:
    
    poll in interface Deque<E>
    
    Specified by:
    
    poll in interface Queue<E>
  - pollFirst
```
public E pollFirst()
```
    Specified by:
    
    pollFirst in interface Deque<E>
  - pollLast
```
public E pollLast()
```
    Specified by:
    
    pollLast in interface Deque<E>
  - pop
```
public E pop()
```
    Specified by:
    
    pop in interface Deque<E>
  - push
```
public void push(E element)
```
    Specified by:
    
    push in interface Deque<E>
  - remove
```
public E remove()
```
    Specified by:
    
    remove in interface Deque<E>
    
    Specified by:
    
    remove in interface Queue<E>
  - removeFirstOccurrence
```
public boolean removeFirstOccurrence(Object object)
```
    Specified by:
    
    removeFirstOccurrence in interface Deque<E>
  - removeLastOccurrence
```
public boolean removeLastOccurrence(Object object)
```
    Specified by:
    
    removeLastOccurrence in interface Deque<E>

Class PLinkedHashSet<E>

Constructor Summary

Method Summary

Methods inherited from class net.sf.joafip.java.util.PAbstractSet

Methods inherited from class net.sf.joafip.java.util.PAbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.List

Constructor Detail

PLinkedHashSet

PLinkedHashSet

PLinkedHashSet

PLinkedHashSet

Method Detail

newInstance

newInstance

addListerner

removeListener

notifyAdded

notifyRemoved

iterator

listIterator

listIterator

size

contains

get

add

add

addOrReplaceToEnd

remove

removeGetRemoved

getLast

removeLast

getFirst

removeFirst

clear

clone

moveToLastPosition

moveDown

moveToFirstPosition

setLinkedHashSupport

getLinkedHashSupport

hashCode

addAll

get

indexOf

lastIndexOf

remove

set

subList

addFirst

addLast

descendingIterator

element

offer

offerFirst

offerLast

peek

peekFirst

peekLast

poll

pollFirst

pollLast

pop

push

remove

removeFirstOccurrence

removeLastOccurrence