com.jerolba.bikey

Interface BikeySet<R,C>

All Superinterfaces:

java.util.Collection<Bikey<R,C>>, java.lang.Iterable<Bikey<R,C>>, java.util.Set<Bikey<R,C>>

All Known Implementing Classes:

TableBikeySet

public interface BikeySet<R,C>
extends java.util.Set<Bikey<R,C>>

Method Summary

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.
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.
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.
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.
default java.util.Spliterator<Bikey<R,C>>	spliterator()
default java.util.stream.Stream<Bikey<R,C>>	stream() Returns a sequential Stream with this collection of pair values as its source.

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

add

boolean add(R row,
            C column)

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.

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

Throws:

java.lang.NullPointerException - if one of the specified elements are null

add

boolean add(Bikey<R,C> key)

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 java.util.Collection<Bikey<R,C>>

Specified by:

add in interface java.util.Set<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

Throws:

java.lang.NullPointerException - if the specified elements is null

remove

boolean remove(R row,
               C column)

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.

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

Throws:

java.lang.NullPointerException - if one of the specified elements are null

remove

boolean remove(java.lang.Object o)

Removes the specified element from this set if it is present

Specified by:

remove in interface java.util.Collection<Bikey<R,C>>

Specified by:

remove in interface java.util.Set<Bikey<R,C>>

Parameters:

o - object to be removed from this set, if present

Returns:

true if this set contained the specified element

Throws:

java.lang.NullPointerException - if the specified element is null

rowKeySet

java.util.Set<R> rowKeySet()

Returns a set of row keys that have one or more values in the BikeySet. Changes to the set will update the underlying table.

Returns:

set of row keys

columnKeySet

java.util.Set<C> columnKeySet()

Returns a set of column keys that have one or more values in the BikeySet. Changes to the set will update the underlying table.

Returns:

set of column keys

contains

boolean contains(R row,
                 C column)

Returns true if this set contains the specified pair of elements.

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

boolean contains(java.lang.Object o)

Returns true if this set contains the specified element.

Specified by:

contains in interface java.util.Collection<Bikey<R,C>>

Specified by:

contains in interface java.util.Set<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

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. Exceptions thrown by the action are relayed to the caller.

Parameters:

action - The action to be performed for each element

Throws:

java.lang.NullPointerException - if the specified action is null

stream

default java.util.stream.Stream<Bikey<R,C>> stream()

Returns a sequential Stream with this collection of pair values as its source.

Specified by:

stream in interface java.util.Collection<Bikey<R,C>>

Returns:

a sequential Stream over the pairs of elements in this collection in the tuple Bikey

spliterator

default java.util.Spliterator<Bikey<R,C>> spliterator()

Specified by:

spliterator in interface java.util.Collection<Bikey<R,C>>

Specified by:

spliterator in interface java.lang.Iterable<Bikey<R,C>>

Specified by:

spliterator in interface java.util.Set<Bikey<R,C>>