gov.sandia.cognition.collection

Interface MultiCollection<T>

Type Parameters:

T - The type of the data in the collection.

All Superinterfaces:

java.util.Collection<T>, java.lang.Iterable<T>

All Known Implementing Classes:

DefaultMultiCollection, RangeExcludedArrayList

public interface MultiCollection<T>
extends java.util.Collection<T>

An interface for a collection that is made up of a group of subcollections.

Since:

3.0

Author:

Justin Basilico

Method Summary

Modifier and Type	Method and Description
int	getSubCollectionsCount() Gets the number of sub-collections in the multi-collection.
java.util.Collection<? extends java.util.Collection<T>>	subCollections() Returns the sub-collections of the multi-collection.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

subCollections

java.util.Collection<? extends java.util.Collection<T>> subCollections()

Returns the sub-collections of the multi-collection.

Returns:

The sub-collection of the multi-collection.

getSubCollectionsCount

int getSubCollectionsCount()

Gets the number of sub-collections in the multi-collection.

Returns:

Number of sub-collections in the multi-collection.