CloseableIteratorCollection (Infinispan JavaDoc All 10.1.0.Beta1 API)

All Superinterfaces:

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

All Known Subinterfaces:

CacheCollection<E>, CacheSet<E>, CloseableIteratorSet<E>

All Known Implementing Classes:

org.infinispan.commands.read.AbstractCloseableIteratorCollection, AbstractDelegatingCacheCollection, AbstractDelegatingCacheSet, AbstractDelegatingCloseableIteratorCollection, AbstractDelegatingCloseableIteratorSet, CacheSetMapper, CloseableIteratorCollectionAdapter, CloseableIteratorSetAdapter, DistributionBulkInterceptor.BackingEntrySet, DistributionBulkInterceptor.BackingKeySet, DistributionBulkInterceptor.TxBackingEntrySet, WriteableCacheCollectionMapper, WriteableCacheSetMapper
```
public interface CloseableIteratorCollection<E>
extends java.util.Collection<E>
```
A collection that defines an iterator method that returns a CloseableIterator instead of a non closeable one. This is needed so that iterators can be properly cleaned up. All other methods will internally clean up any iterators created and don't have other side effects.

Since:

7.0

Author:

wburns

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`CloseableIterator<E>`	`iterator()`
`default java.util.stream.Stream<E>`	`parallelStream()`
`CloseableSpliterator<E>`	`spliterator()`
`default java.util.stream.Stream<E>`	`stream()`

Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, removeIf, retainAll, size, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - iterator
```
CloseableIterator<E> iterator()
```
    This iterator should be explicitly closed when iteration upon it is completed. Failure to do so could cause resources to not be freed properly
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
  - spliterator
```
CloseableSpliterator<E> spliterator()
```
    This spliterator should be explicitly closed after it has been used. Failure to do so could cause resources to not be freed properly
    
    Specified by:
    
    spliterator in interface java.util.Collection<E>
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<E>
  - stream
```
default java.util.stream.Stream<E> stream()
```
    This stream should be explicitly closed after it has been used. Failure to do so could cause resources to not be freed properly
    
    Specified by:
    
    stream in interface java.util.Collection<E>
  - parallelStream
```
default java.util.stream.Stream<E> parallelStream()
```
    This stream should be explicitly closed after it has been used. Failure to do so could cause resources to not be freed properly
    
    Specified by:
    
    parallelStream in interface java.util.Collection<E>