DequeSnapshot (Sodeac Common 0.5.4 API)

java.lang.Object
- org.sodeac.common.snapdeque.DequeSnapshot<E>

Type Parameters:

E -

All Implemented Interfaces:

AutoCloseable, Iterable<E>, Collection<E>
```
public class DequeSnapshot<E>
extends Object
implements AutoCloseable, Collection<E>
```
A Snapshot of SnapshotableDeque implements Collection. Write operations of collection (...) impacts the source deque, not the snapshot itself. A snapshot is not a deep copy of deque's content at the time of creation. The overhead to create a snapshot is very slightly, regardless of deque's size. Iterate through a snapshot also does not produce a deep copy and requires no locks inside of snapshot or source deque. A Snapshot has to be closed if it is not required anymore. Otherwise the helper links of removed elements remain in source deque and the gc does not release the memory.

Author:

Sebastian Palarus

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DequeSnapshot.ElementSnapshotIterator` private helper class
`protected class`	`DequeSnapshot.LinkSnapshotIterator` private helper class
`protected class`	`DequeSnapshot.NodeSnapshotIterator` private helper class
`protected class`	`DequeSnapshot.SnapshotIterator` private helper class

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`closed`
`protected DequeNode.Link<E>`	`firstLink`
`protected DequeNode.Link<E>`	`lastLink`
`protected Integer`	`pollCapacity`
`protected long`	`size`
`protected SnapshotableDeque<E>`	`snapshotableDeque`
`protected UUID`	`uuid`
`protected SnapshotableDeque.SnapshotVersion<E>`	`version`

Constructor Summary

Constructors
Modifier Constructor and Description

protected DequeSnapshot(SnapshotableDeque<E> snapshotableDeque, boolean poll, Integer pollCapacity)

Constructors
Modifier	Constructor and Description
`protected`	`DequeSnapshot(SnapshotableDeque<E> snapshotableDeque, boolean poll, Integer pollCapacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`boolean`	`addAll(Collection<? extends E> c)`
`void`	`clear()`
`void`	`close()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`equals(Object obj)`
`E`	`getFirstElement()` Returns first element
`protected DequeNode.Link<E>`	`getFirstLink()`
`DequeNode<E>`	`getFirstNode()` Returns first node
`E`	`getLastElement()` Returns last element
`protected DequeNode.Link<E>`	`getLastLink()`
`DequeNode<E>`	`getLastNode()` Returns last node
`protected DequeNode.Link<E>`	`getLink(E o)` Find link by element (same object)
`DequeNode<E>`	`getNode(E o)` Find node by element (same object)
`protected SnapshotableDeque<E>`	`getParent()`
`long`	`getVersion()` Returns the version of deque the snapshot was created
`int`	`hashCode()`
`boolean`	`isClosed()` returns true if snapshot is closed, otherwise false
`boolean`	`isEmpty()`
`Iterator<E>`	`iterator()`
`protected Iterable<DequeNode.Link<E>>`	`linkIterable()` Returns link iterable
`Iterable<DequeNode<E>>`	`nodeIterable()` Returns node iterable
`Stream<DequeNode<E>>`	`nodeStream()` Returns node stream
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`int`	`size()`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`

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

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

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - uuid
```
protected UUID uuid
```
  - version
```
protected SnapshotableDeque.SnapshotVersion<E> version
```
  - snapshotableDeque
```
protected SnapshotableDeque<E> snapshotableDeque
```
  - firstLink
```
protected DequeNode.Link<E> firstLink
```
  - lastLink
```
protected DequeNode.Link<E> lastLink
```
  - closed
```
protected volatile boolean closed
```
  - size
```
protected long size
```
  - pollCapacity
```
protected Integer pollCapacity
```
- Constructor Detail
  - DequeSnapshot
```
protected DequeSnapshot(SnapshotableDeque<E> snapshotableDeque,
                        boolean poll,
                        Integer pollCapacity)
```
- Method Detail
  - getParent
```
protected SnapshotableDeque<E> getParent()
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - isClosed
```
public boolean isClosed()
```
    returns true if snapshot is closed, otherwise false
    
    Returns:
    
    true if snapshot is closed, otherwise false
  - getVersion
```
public long getVersion()
```
    Returns the version of deque the snapshot was created
    
    Returns:
    
    version of deque the snapshot was created
  - getLink
```
protected DequeNode.Link<E> getLink(E o)
```
    Find link by element (same object)
    
    Parameters:
    
    o - element
    
    Returns:
    
    matched link
  - getNode
```
public DequeNode<E> getNode(E o)
```
    Find node by element (same object)
    
    Parameters:
    
    o - element
    
    Returns:
    
    matched node
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
  - linkIterable
```
protected Iterable<DequeNode.Link<E>> linkIterable()
```
    Returns link iterable
    
    Returns:
    
    link iterable
  - nodeIterable
```
public Iterable<DequeNode<E>> nodeIterable()
```
    Returns node iterable
    
    Returns:
    
    node iterable
  - nodeStream
```
public Stream<DequeNode<E>> nodeStream()
```
    Returns node stream
    
    Returns:
    
    node stream
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<E>
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface Collection<E>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<E>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<E>
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface Collection<E>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<E>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
  - getFirstElement
```
public E getFirstElement()
```
    Returns first element
    
    Returns:
    
    first element
  - getFirstLink
```
protected DequeNode.Link<E> getFirstLink()
```
  - getFirstNode
```
public DequeNode<E> getFirstNode()
```
    Returns first node
    
    Returns:
    
    first node
  - getLastElement
```
public E getLastElement()
```
    Returns last element
    
    Returns:
    
    last element
  - getLastLink
```
protected DequeNode.Link<E> getLastLink()
```
  - getLastNode
```
public DequeNode<E> getLastNode()
```
    Returns last node
    
    Returns:
    
    last node
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<E>
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Collection<E>
    
    Overrides:
    
    equals in class Object

Class DequeSnapshot<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

uuid

version

snapshotableDeque

firstLink

lastLink

closed

size

pollCapacity

Constructor Detail

DequeSnapshot

Method Detail

getParent

close

isClosed

getVersion

getLink

getNode

iterator

linkIterable

nodeIterable

nodeStream

size

isEmpty

contains

toArray

toArray

add

remove

containsAll

addAll

removeAll

retainAll

clear

getFirstElement

getFirstLink

getFirstNode

getLastElement

getLastLink

getLastNode

hashCode

equals