FastSiblingDeque (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.util.FastSiblingDeque<E>

Type Parameters:

E - The type of the objects stored in this structure.

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Deque<E>, java.util.Queue<E>
```
public class FastSiblingDeque<E>
extends java.lang.Object
implements java.util.Deque<E>
```
A Deque with support for access of siblings of a particular element. It is logically that, to uniquely identify the elements from this Collection for querying its sibling there must NOT be duplicated entries. The implementation prevents this by throwing exceptions or returning false at any attempt to duplicate an entry.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class FastSiblingDeque.FsdNode<E>
A node in double-linked list of FastSiblingDeque.

Nested Classes
Modifier and Type	Class and Description
`private static class`	`FastSiblingDeque.FsdNode<E>` A node in double-linked list of `FastSiblingDeque`.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<E,FastSiblingDeque.FsdNode<E>>`	`data` Internal data structure is a map for fast direct access to independent elements.
`private FastSiblingDeque.FsdNode<E>`	`first` The head of the deque.
`private FastSiblingDeque.FsdNode<E>`	`last` The tail of the deque.

Constructor Summary

Constructors
Constructor and Description

FastSiblingDeque()

Constructors
Constructor and Description
`FastSiblingDeque()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)` Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and throwing an `IllegalStateException` if no space is currently available.
`boolean`	`addAll(java.util.Collection<? extends E> c)`
`void`	`addFirst(E e)`
`void`	`addLast(E e)`
`void`	`clear()`
`boolean`	`contains(java.lang.Object o)` Returns `true` if this deque contains the specified element.
`boolean`	`containsAll(java.util.Collection<?> c)`
`java.util.Iterator<E>`	`descendingIterator()`
`E`	`element()`
`E`	`getFirst()`
`E`	`getLast()`
`E`	`getNext(E e)` Get the next element after `e`.
`E`	`getPrevious(E e)` Get the previous element before `e`.
`boolean`	`isEmpty()` Returns `true` if this collection contains no elements.
`java.util.Iterator<E>`	`iterator()`
`static void`	`main(java.lang.String[] args)` Quick testing.
`boolean`	`offer(E e)`
`boolean`	`offerFirst(E e)`
`boolean`	`offerLast(E e)`
`E`	`peek()`
`E`	`peekFirst()` Retrieves, but does not remove, the first element of this deque, or returns `null` if this deque is empty.
`E`	`peekLast()` Retrieves, but does not remove, the last element of this deque, or returns `null` if this deque is empty.
`E`	`poll()`
`E`	`pollFirst()`
`E`	`pollLast()`
`E`	`pop()`
`void`	`push(E e)`
`E`	`remove()`
`boolean`	`remove(java.lang.Object o)` Removes the first occurrence of the specified element from this deque.
`boolean`	`removeAll(java.util.Collection<?> c)`
`E`	`removeFirst()`
`boolean`	`removeFirstOccurrence(java.lang.Object o)`
`E`	`removeLast()`
`boolean`	`removeLastOccurrence(java.lang.Object o)`
`boolean`	`retainAll(java.util.Collection<?> c)`
`int`	`size()`
`java.lang.Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection
equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - data
```
private java.util.Map<E,FastSiblingDeque.FsdNode<E>> data
```
    Internal data structure is a map for fast direct access to independent elements.
  - first
```
private FastSiblingDeque.FsdNode<E> first
```
    The head of the deque.
  - last
```
private FastSiblingDeque.FsdNode<E> last
```
    The tail of the deque.
- Constructor Detail
  - FastSiblingDeque
```
public FastSiblingDeque()
```
- Method Detail
  - getNext
```
public E getNext(E e)
```
    Get the next element after e. If the collection is empty or the element is the last one, then null is returned.
    
    Parameters:
    
    e - An element from collection to obtain its next sibling.
    
    Returns:
    
    The next element to follow e when iterating this collection.
  - getPrevious
```
public E getPrevious(E e)
```
    Get the previous element before e. If the collection is empty or the element is the first one, then null is returned.
    
    Parameters:
    
    e - An element from collection to obtain its previous sibling.
    
    Returns:
    
    The next element to follow e when reverse iterating this collection.
  - addFirst
```
public void addFirst(E e)
```
    Specified by:
    
    addFirst in interface java.util.Deque<E>
  - addLast
```
public void addLast(E e)
```
    Specified by:
    
    addLast in interface java.util.Deque<E>
  - offerFirst
```
public boolean offerFirst(E e)
```
    Specified by:
    
    offerFirst in interface java.util.Deque<E>
  - offerLast
```
public boolean offerLast(E e)
```
    Specified by:
    
    offerLast in interface java.util.Deque<E>
  - removeFirst
```
public E removeFirst()
```
    Specified by:
    
    removeFirst in interface java.util.Deque<E>
  - removeLast
```
public E removeLast()
```
    Specified by:
    
    removeLast in interface java.util.Deque<E>
  - pollFirst
```
public E pollFirst()
```
    Specified by:
    
    pollFirst in interface java.util.Deque<E>
  - pollLast
```
public E pollLast()
```
    Specified by:
    
    pollLast in interface java.util.Deque<E>
  - getFirst
```
public E getFirst()
```
    Specified by:
    
    getFirst in interface java.util.Deque<E>
  - getLast
```
public E getLast()
```
    Specified by:
    
    getLast in interface java.util.Deque<E>
  - peekFirst
```
public E peekFirst()
```
    Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.
    
    Specified by:
    
    peekFirst in interface java.util.Deque<E>
    
    Returns:
    
    the head of this deque, or null if this deque is empty
  - peekLast
```
public E peekLast()
```
    Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.
    
    Specified by:
    
    peekLast in interface java.util.Deque<E>
    
    Returns:
    
    the tail of this deque, or null if this deque is empty
  - removeFirstOccurrence
```
public boolean removeFirstOccurrence(java.lang.Object o)
```
    Specified by:
    
    removeFirstOccurrence in interface java.util.Deque<E>
  - removeLastOccurrence
```
public boolean removeLastOccurrence(java.lang.Object o)
```
    Specified by:
    
    removeLastOccurrence in interface java.util.Deque<E>
  - add
```
public boolean add(E e)
```
    Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.
    This method is equivalent to addLast(E).
    
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Specified by:
    
    add in interface java.util.Deque<E>
    
    Specified by:
    
    add in interface java.util.Queue<E>
    
    Parameters:
    
    e - the element to add
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    Throws:
    
    java.lang.ClassCastException - if the class of the specified element prevents it from being added to this deque
  - offer
```
public boolean offer(E e)
```
    Specified by:
    
    offer in interface java.util.Deque<E>
    
    Specified by:
    
    offer in interface java.util.Queue<E>
  - remove
```
public E remove()
```
    Specified by:
    
    remove in interface java.util.Deque<E>
    
    Specified by:
    
    remove in interface java.util.Queue<E>
  - poll
```
public E poll()
```
    Specified by:
    
    poll in interface java.util.Deque<E>
    
    Specified by:
    
    poll in interface java.util.Queue<E>
  - element
```
public E element()
```
    Specified by:
    
    element in interface java.util.Deque<E>
    
    Specified by:
    
    element in interface java.util.Queue<E>
  - peek
```
public E peek()
```
    Specified by:
    
    peek in interface java.util.Deque<E>
    
    Specified by:
    
    peek in interface java.util.Queue<E>
  - push
```
public void push(E e)
```
    Specified by:
    
    push in interface java.util.Deque<E>
  - pop
```
public E pop()
```
    Specified by:
    
    pop in interface java.util.Deque<E>
  - remove
```
public boolean remove(java.lang.Object o)
```
    Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).
    
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Specified by:
    
    remove in interface java.util.Deque<E>
    
    Parameters:
    
    o - element to be removed from this deque, if present
    
    Returns:
    
    true if an element was removed as a result of this call
    
    Throws:
    
    java.lang.ClassCastException - if the class of the specified element is incompatible with this structure
  - containsAll
```
public boolean containsAll(java.util.Collection<?> c)
```
    Specified by:
    
    containsAll in interface java.util.Collection<E>
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface java.util.Collection<E>
  - removeAll
```
public boolean removeAll(java.util.Collection<?> c)
```
    Specified by:
    
    removeAll in interface java.util.Collection<E>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> c)
```
    Specified by:
    
    retainAll in interface java.util.Collection<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E>
  - contains
```
public boolean contains(java.lang.Object o)
```
    Returns true if this deque contains the specified element.
    
    Specified by:
    
    contains in interface java.util.Collection<E>
    
    Specified by:
    
    contains in interface java.util.Deque<E>
    
    Parameters:
    
    o - element whose presence in this deque is to be tested
    
    Returns:
    
    true if this deque contains the specified element
    
    Throws:
    
    java.lang.ClassCastException - if the type of the specified element is incompatible with this deque
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in interface java.util.Deque<E>
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this collection contains no elements.
    
    Specified by:
    
    isEmpty in interface java.util.Collection<E>
    
    Returns:
    
    true if this collection contains no elements
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.Deque<E>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
  - descendingIterator
```
public java.util.Iterator<E> descendingIterator()
```
    Specified by:
    
    descendingIterator in interface java.util.Deque<E>
  - main
```
public static void main(java.lang.String[] args)
```
    Quick testing.

Class FastSiblingDeque<E>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

data

first

last

Constructor Detail

FastSiblingDeque

Method Detail

getNext

getPrevious

addFirst

addLast

offerFirst

offerLast

removeFirst

removeLast

pollFirst

pollLast

getFirst

getLast

peekFirst

peekLast

removeFirstOccurrence

removeLastOccurrence

add

offer

remove

poll

element

peek

push

pop

remove

containsAll

addAll

removeAll

retainAll

clear

contains

size

isEmpty

iterator

toArray

toArray

descendingIterator

main