KeyedSet.Empty (org.genantics:keyedset 0.1 API)

java.lang.Object
- org.genantics.set.KeyedSet<K,T>
- - org.genantics.set.KeyedSet.Empty<T,K>

All Implemented Interfaces:

Iterable<T>

Enclosing class:

KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
```
protected static class KeyedSet.Empty<T extends Keyed<K>,K extends Comparable<K>>
extends KeyedSet<K,T>
```
Empty is a singleton object representing the empty set. The type parameters really have no meaning for Empty; it is applicable to all types.

Nested Class Summary
- Nested classes/interfaces inherited from class org.genantics.set.KeyedSet
  KeyedSet.Empty<T extends Keyed<K>,K extends Comparable<K>>, KeyedSet.ReverseTreeIterable, KeyedSet.ReverseTreeIterator, KeyedSet.ReverseValueIterable, KeyedSet.ReverseValueIterator, KeyedSet.TreeIterable, KeyedSet.TreeState, KeyedSet.ValueIterable, KeyedSet.ValueIterator

Field Summary
- Fields inherited from class org.genantics.set.KeyedSet
  EMPTY, height, left, member, right

Constructor Summary

Constructors
Modifier Constructor and Description

protected KeyedSet.Empty()

Constructors
Modifier	Constructor and Description
`protected`	`KeyedSet.Empty()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected KeyedSet<K,T>`	`addElement(T element, boolean[] added)` addEntry returns this tree with added element
`void`	`collect(Collection<T> collection)` Add all elements to collection.
`boolean`	`containsAll(Iterable<T> elements)`
`boolean`	`containsAny(Iterable<T> elements)`
`boolean`	`containsKey(K key)` Test if tree contains the specified key.
`protected boolean`	`containsKey(T value)`
`KeyedSet<K,T>`	`deleteFirst()` Delete the first element of the tree.
`protected KeyedSet<K,T>`	`deleteKey(K key, boolean[] deleted)`
`KeyedSet<K,T>`	`deleteLast()` Delete the last element of the tree.
`Iterable<T>`	`elements()` Return an iterable that can be used in foreach to obtain elements in ascending order.
`boolean`	`equals(Object o)` Compare sets.
`KeyedSet<K,T>`	`filter(Filter filter)` Filter the set, removing all elements for which the `test` method returns false.
`T`	`get(K key)` Get the element with matching key.
`T`	`getFirst()` Get the first element in the tree.
`T`	`getLast()` Get the last element in the tree.
`int`	`hashCode()` Get the hashCode for the set.
`protected void`	`init()`
`boolean`	`isEmpty()`
`Iterator<T>`	`iterator()` Return an iterator over the elements of the set in ascending order.
`void`	`prettyPrint()`
`KeyedSet<K,T>`	`removeAll(Iterable<T> iterable)` Remove all elements in iterable from tree.
`protected KeyedSet<K,T>`	`removeElement(T value, boolean[] removed)`
`KeyedSet<K,T>`	`retainAll(Iterable<T> iterable)` Get all elements in both set and iterable.
`Iterable<T>`	`reverseElements()` Return an iterable that can be used in foreach to obtain elements in descending order.
`Iterator<T>`	`reverseIterator()` Return an iterator over the elements of the set in descending order.
`int`	`size()` Get the tree size.
`String`	`toString()`
`boolean`	`visitFwd(ConditionalVisitor visitor)` Visit elements in order.
`void`	`visitFwd(Visitor visitor)` Visit all elements in order.
`boolean`	`visitRev(ConditionalVisitor visitor)` Visit all elements in reverse order.
`void`	`visitRev(Visitor visitor)` Visit all elements in reverse order.

Methods inherited from class org.genantics.set.KeyedSet
add, add, addAll, balanceTree, clear, contains, delete, delete, getBalance, keys, newTree, prettyPrint, remove, remove, removeHigh, reverseKeys, setLeft, setRight

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

- Constructor Detail
  - KeyedSet.Empty
```
protected KeyedSet.Empty()
```
- Method Detail
  - init
```
protected void init()
```
    Overrides:
    
    init in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: KeyedSet
    
    Compare sets. This is an O(n) operation.
    
    Overrides:
    
    equals in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Parameters:
    o - object
    
    Returns:
    true if both sets contain the same number of elements and for each pairwise element equals returns true; otherwise, false
  - hashCode
```
public int hashCode()
```
    Description copied from class: KeyedSet
    
    Get the hashCode for the set. This is an O(n) operation.
    
    Overrides:
    
    hashCode in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    hash code
  - size
```
public int size()
```
    Description copied from class: KeyedSet
    
    Get the tree size. Note this is an O(n) operation. Use isEmpty() rather than getSize() == 0.
    
    Overrides:
    
    size in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    the number of elements in the set
  - containsKey
```
public boolean containsKey(K key)
```
    Description copied from class: KeyedSet
    
    Test if tree contains the specified key.
    
    Overrides:
    
    containsKey in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    true if key matched in tree; otherwise, false
  - getFirst
```
public T getFirst()
```
    Description copied from class: KeyedSet
    
    Get the first element in the tree.
    
    Overrides:
    
    getFirst in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    element with lowest key value
  - getLast
```
public T getLast()
```
    Description copied from class: KeyedSet
    
    Get the last element in the tree.
    
    Overrides:
    
    getLast in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    element with highest key value
  - deleteFirst
```
public KeyedSet<K,T> deleteFirst()
```
    Description copied from class: KeyedSet
    
    Delete the first element of the tree. If called with an empty tree, returns an empty tree.
    
    Overrides:
    
    deleteFirst in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    tree without first element, if any
  - deleteLast
```
public KeyedSet<K,T> deleteLast()
```
    Description copied from class: KeyedSet
    
    Delete the last element of the tree. If called with an empty tree, returns an empty tree.
    
    Overrides:
    
    deleteLast in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    tree without last element, if any
  - containsKey
```
protected boolean containsKey(T value)
```
    Overrides:
    
    containsKey in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
  - isEmpty
```
public boolean isEmpty()
```
    Overrides:
    
    isEmpty in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    true if set is empty; otherwise false
  - addElement
```
protected KeyedSet<K,T> addElement(T element,
                       boolean[] added)
```
    Description copied from class: KeyedSet
    
    addEntry returns this tree with added element
    
    Overrides:
    
    addElement in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
  - get
```
public T get(K key)
```
    Description copied from class: KeyedSet
    
    Get the element with matching key.
    
    Overrides:
    
    get in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    element or null if not found
  - deleteKey
```
protected KeyedSet<K,T> deleteKey(K key,
                      boolean[] deleted)
```
    Overrides:
    
    deleteKey in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
  - removeElement
```
protected KeyedSet<K,T> removeElement(T value,
                          boolean[] removed)
```
    Overrides:
    
    removeElement in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
  - iterator
```
public Iterator<T> iterator()
```
    Description copied from class: KeyedSet
    
    Return an iterator over the elements of the set in ascending order. Since the tree is immutable, the iterator will never throw ConcurrentModificationException.
    
    Specified by:
    
    iterator in interface Iterable<T extends Keyed<K>>
    
    Overrides:
    
    iterator in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    iterator
  - reverseIterator
```
public Iterator<T> reverseIterator()
```
    Description copied from class: KeyedSet
    
    Return an iterator over the elements of the set in descending order. Since the tree is immutable, the iterator will never throw ConcurrentModificationException.
    
    Overrides:
    
    reverseIterator in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    iterator
  - elements
```
public Iterable<T> elements()
```
    Description copied from class: KeyedSet
    
    Return an iterable that can be used in foreach to obtain elements in ascending order.
    
    Overrides:
    
    elements in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    iterable
    See Also:
    KeyedSet.iterator()
  - reverseElements
```
public Iterable<T> reverseElements()
```
    Description copied from class: KeyedSet
    
    Return an iterable that can be used in foreach to obtain elements in descending order.
    
    Overrides:
    
    reverseElements in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    iterable
    See Also:
    KeyedSet.reverseIterator()
  - removeAll
```
public KeyedSet<K,T> removeAll(Iterable<T> iterable)
```
    Description copied from class: KeyedSet
    
    Remove all elements in iterable from tree.
    
    Overrides:
    
    removeAll in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Parameters:
    iterable - elements to remove
    
    Returns:
    set - iterable elements
  - retainAll
```
public KeyedSet<K,T> retainAll(Iterable<T> iterable)
```
    Description copied from class: KeyedSet
    
    Get all elements in both set and iterable.
    
    Overrides:
    
    retainAll in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    {element} such that element in set and element in iterable
  - visitFwd
```
public void visitFwd(Visitor visitor)
```
    Description copied from class: KeyedSet
    
    Visit all elements in order.
    
    Overrides:
    
    visitFwd in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Parameters:
    visitor - visits each element
  - visitFwd
```
public boolean visitFwd(ConditionalVisitor visitor)
```
    Description copied from class: KeyedSet
    
    Visit elements in order.
    
    Overrides:
    
    visitFwd in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Parameters:
    visitor - visits each element, returning false if next element is to be visited; otherwise true (desired/last element found)
    
    Returns:
    false if all elements visited; otherwise, true
  - visitRev
```
public void visitRev(Visitor visitor)
```
    Description copied from class: KeyedSet
    
    Visit all elements in reverse order.
    
    Overrides:
    
    visitRev in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Parameters:
    visitor - visits each element
  - visitRev
```
public boolean visitRev(ConditionalVisitor visitor)
```
    Description copied from class: KeyedSet
    
    Visit all elements in reverse order.
    
    Overrides:
    
    visitRev in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Parameters:
    visitor - visits each element, returning false if next element is to be visited; otherwise true (desired element found)
    
    Returns:
    false if all elements visited; otherwise true
  - filter
```
public KeyedSet<K,T> filter(Filter filter)
```
    Description copied from class: KeyedSet
    
    Filter the set, removing all elements for which the test method returns false.
    
    Overrides:
    
    filter in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    filtered tree
  - collect
```
public void collect(Collection<T> collection)
```
    Description copied from class: KeyedSet
    
    Add all elements to collection.
    
    Overrides:
    
    collect in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Parameters:
    collection - target
  - containsAll
```
public boolean containsAll(Iterable<T> elements)
```
    Overrides:
    
    containsAll in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    true if set contains all elements in elements; otherwise false
  - containsAny
```
public boolean containsAny(Iterable<T> elements)
```
    Overrides:
    
    containsAny in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
    
    Returns:
    true if set contains any elements in elements; otherwise false
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>
  - prettyPrint
```
public void prettyPrint()
```
    Overrides:
    
    prettyPrint in class KeyedSet<K extends Comparable<K>,T extends Keyed<K>>

Class KeyedSet.Empty<T extends Keyed<K>,K extends Comparable<K>>

Nested Class Summary

Nested classes/interfaces inherited from class org.genantics.set.KeyedSet

Field Summary

Fields inherited from class org.genantics.set.KeyedSet

Constructor Summary

Method Summary

Methods inherited from class org.genantics.set.KeyedSet

Methods inherited from class java.lang.Object

Constructor Detail

KeyedSet.Empty

Method Detail

init

equals

hashCode

size

containsKey

getFirst

getLast

deleteFirst

deleteLast

containsKey

isEmpty

addElement

get

deleteKey

removeElement

iterator

reverseIterator

elements

reverseElements

removeAll

retainAll

visitFwd

visitFwd

visitRev

visitRev

filter

collect

containsAll

containsAny

toString

prettyPrint