TableBikeySet (bikey 0.9.0 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<Bikey<R,C>>
  - - com.jerolba.bikey.TableBikeySet<R,C>

All Implemented Interfaces:

BikeySet<R,C>, java.lang.Cloneable, java.lang.Iterable<Bikey<R,C>>, java.util.Collection<Bikey<R,C>>, java.util.Set<Bikey<R,C>>
```
public class TableBikeySet<R,C>
extends java.util.AbstractSet<Bikey<R,C>>
implements BikeySet<R,C>, java.lang.Cloneable
```

Constructor Summary

Constructors
Constructor and Description
`TableBikeySet()` Constructs a new, empty set
`TableBikeySet(BikeySet<? extends R,? extends C> bikeySet)` Constructs a new set containing the elements in the specified set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Bikey<R,C> key)` Adds the specified bikey to this set if it is not already present.
`boolean`	`add(R row, C column)` Adds the specified pair of element to this set if they are not already present.
`void`	`clear()` Removes all of the elements from this set.
`java.lang.Object`	`clone()` Returns a shallow copy of this `TableBikeySet` instance: the elements themselves are not cloned.
`java.util.Set<C>`	`columnKeySet()` Returns a set of column keys that have one or more values in the `BikeySet`.
`boolean`	`contains(java.lang.Object o)` Returns `true` if this set contains the specified element.
`boolean`	`contains(R row, C column)` Returns `true` if this set contains the specified pair of elements.
`boolean`	`equals(java.lang.Object o)`
`void`	`forEach(java.util.function.BiConsumer<? super R,? super C> action)` Performs the given action for each pair of element of the set until all elements have been processed or the action throws an exception.
`void`	`forEach(java.util.function.Consumer<? super Bikey<R,C>> action)`
`int`	`hashCode()`
`java.util.Iterator<Bikey<R,C>>`	`iterator()` Returns an iterator over the elements in this set.
`boolean`	`remove(java.lang.Object o)` Removes the specified element from this set if it is present
`boolean`	`remove(R row, C column)` Removes the specified pair of elements from this set if they are present.
`java.util.Set<R>`	`rowKeySet()` Returns a set of row keys that have one or more values in the `BikeySet`.
`int`	`size()` Returns the number of elements in this set (its cardinality).

Methods inherited from class java.util.AbstractSet
removeAll

Methods inherited from class java.util.AbstractCollection
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 com.jerolba.bikey.BikeySet
spliterator, stream

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

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

- Constructor Detail
  - TableBikeySet
```
public TableBikeySet()
```
    Constructs a new, empty set
  - TableBikeySet
```
public TableBikeySet(BikeySet<? extends R,? extends C> bikeySet)
```
    Constructs a new set containing the elements in the specified set.
    
    Parameters:
    
    bikeySet - the collection whose elements are to be placed into this set
    
    Throws:
    
    java.lang.NullPointerException - if the specified collection is null
- Method Detail
  - add
```
public boolean add(R row,
                   C column)
```
    Description copied from interface: BikeySet
    
    Adds the specified pair of element to this set if they are not already present.
    If this set already contains the element, the call leaves the set unchanged and returns false. This ensures that sets never contain duplicate elements.
    
    Specified by:
    
    add in interface BikeySet<R,C>
    
    Parameters:
    
    row - row element to be added to this set
    
    column - column element to be added to this set
    
    Returns:
    
    true if this set did not already contain the specified pair of elements
  - add
```
public boolean add(Bikey<R,C> key)
```
    Description copied from interface: BikeySet
    
    Adds the specified bikey to this set if it is not already present.
    If this set already contains the element, the call leaves the set unchanged and returns false. This ensures that sets never contain duplicate elements.
    
    Specified by:
    
    add in interface BikeySet<R,C>
    
    Specified by:
    
    add in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    add in interface java.util.Set<Bikey<R,C>>
    
    Overrides:
    
    add in class java.util.AbstractCollection<Bikey<R,C>>
    
    Parameters:
    
    key - bikey element to be added to this set
    
    Returns:
    
    true if this set did not already contain the specified bikey
  - remove
```
public boolean remove(R row,
                      C column)
```
    Description copied from interface: BikeySet
    
    Removes the specified pair of elements from this set if they are present.
    If after a removal, one column has no items in any row, its metainfo is not deleted and potentially the set can occupy a lot of space being empty.
    
    Specified by:
    
    remove in interface BikeySet<R,C>
    
    Parameters:
    
    row - row element to be removed from this set, if present
    
    column - column element to be removed from this set, if present
    
    Returns:
    
    true if this set contained the specified pair of elements
  - remove
```
public boolean remove(java.lang.Object o)
```
    Description copied from interface: BikeySet
    
    Removes the specified element from this set if it is present
    
    Specified by:
    
    remove in interface BikeySet<R,C>
    
    Specified by:
    
    remove in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    remove in interface java.util.Set<Bikey<R,C>>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<Bikey<R,C>>
    
    Parameters:
    
    o - object to be removed from this set, if present
    
    Returns:
    
    true if this set contained the specified element
  - rowKeySet
```
public java.util.Set<R> rowKeySet()
```
    Description copied from interface: BikeySet
    
    Returns a set of row keys that have one or more values in the BikeySet. Changes to the set will update the underlying table.
    
    Specified by:
    
    rowKeySet in interface BikeySet<R,C>
    
    Returns:
    
    set of row keys
  - columnKeySet
```
public java.util.Set<C> columnKeySet()
```
    Description copied from interface: BikeySet
    
    Returns a set of column keys that have one or more values in the BikeySet. Changes to the set will update the underlying table.
    
    Specified by:
    
    columnKeySet in interface BikeySet<R,C>
    
    Returns:
    
    set of column keys
  - contains
```
public boolean contains(R row,
                        C column)
```
    Description copied from interface: BikeySet
    
    Returns true if this set contains the specified pair of elements.
    
    Specified by:
    
    contains in interface BikeySet<R,C>
    
    Parameters:
    
    row - row element whose presence in this set is to be tested
    
    column - column element whose presence in this set is to be tested
    
    Returns:
    
    true if this set contains the specified pair of elements
  - contains
```
public boolean contains(java.lang.Object o)
```
    Description copied from interface: BikeySet
    
    Returns true if this set contains the specified element.
    
    Specified by:
    
    contains in interface BikeySet<R,C>
    
    Specified by:
    
    contains in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    contains in interface java.util.Set<Bikey<R,C>>
    
    Overrides:
    
    contains in class java.util.AbstractCollection<Bikey<R,C>>
    
    Parameters:
    
    o - element whose presence in this set is to be tested
    
    Returns:
    
    true if this set contains the specified element
  - forEach
```
public void forEach(java.util.function.BiConsumer<? super R,? super C> action)
```
    Description copied from interface: BikeySet
    
    Performs the given action for each pair of element of the set until all elements have been processed or the action throws an exception. Exceptions thrown by the action are relayed to the caller.
    
    Specified by:
    
    forEach in interface BikeySet<R,C>
    
    Parameters:
    
    action - The action to be performed for each element
  - forEach
```
public void forEach(java.util.function.Consumer<? super Bikey<R,C>> action)
```
    Specified by:
    
    forEach in interface java.lang.Iterable<Bikey<R,C>>
  - iterator
```
public java.util.Iterator<Bikey<R,C>> iterator()
```
    Returns an iterator over the elements in this set. The elements are returned in no particular order.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Bikey<R,C>>
    
    Specified by:
    
    iterator in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    iterator in interface java.util.Set<Bikey<R,C>>
    
    Specified by:
    
    iterator in class java.util.AbstractCollection<Bikey<R,C>>
    
    Returns:
    
    an iterator over the pair of elements in this set
  - size
```
public int size()
```
    Returns the number of elements in this set (its cardinality).
    
    Specified by:
    
    size in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    size in interface java.util.Set<Bikey<R,C>>
    
    Specified by:
    
    size in class java.util.AbstractCollection<Bikey<R,C>>
    
    Returns:
    
    the number of elements in this set (its cardinality)
  - clear
```
public void clear()
```
    Removes all of the elements from this set. The set will be empty after this call returns.
    
    Specified by:
    
    clear in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    clear in interface java.util.Set<Bikey<R,C>>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<Bikey<R,C>>
  - clone
```
public java.lang.Object clone()
```
    Returns a shallow copy of this TableBikeySet instance: the elements themselves are not cloned.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a shallow copy of this set
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    equals in interface java.util.Set<Bikey<R,C>>
    
    Overrides:
    
    equals in class java.util.AbstractSet<Bikey<R,C>>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Collection<Bikey<R,C>>
    
    Specified by:
    
    hashCode in interface java.util.Set<Bikey<R,C>>
    
    Overrides:
    
    hashCode in class java.util.AbstractSet<Bikey<R,C>>

Class TableBikeySet<R,C>

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractSet

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface com.jerolba.bikey.BikeySet

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Constructor Detail

TableBikeySet

TableBikeySet

Method Detail

add

add

remove

remove

rowKeySet

columnKeySet

contains

contains

forEach

forEach

iterator

size

clear

clone

equals

hashCode