AmetysObjectIterable (Ametys 4.5.x - API)

Type Parameters:

A - the actual type of AmetysObjects.

All Superinterfaces:

AutoCloseable, Closeable, Iterable<A>

All Known Implementing Classes:

ChainedAmetysObjectIterable, CollatingUniqueAmetysObjectIterable, CollectionIterable, EmptyIterable, IdCollectionIterable, NodeIteratorIterable, StaticZone.StaticZoneItemIterable, UniqueChainedAmetysObjectIterable
```
public interface AmetysObjectIterable<A extends AmetysObject>
extends Iterable<A>, Closeable
```
Allows iteration through AmetysObjects.
It implements Iterable, allowing foreach statements.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`close()`	Close the associated resources. An `AmetysObjectIterable` must NOT be closed if any of the contained `AmetysObject` is still in use.
`long`	`getSize()`	Returns the number of elements in this iterable.
`AmetysObjectIterator<A>`	`iterator()`
`default Spliterator<A>`	`spliterator()`
`default Stream<A>`	`stream()`	Returns a sequential `Stream` with this iterable as its source.

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - getSize
```
long getSize()
```
    Returns the number of elements in this iterable. If this information is unavailable, returns -1.
    
    Returns:
    
    a long
  - iterator
```
AmetysObjectIterator<A> iterator()
```
    Specified by:
    
    iterator in interface Iterable<A extends AmetysObject>
  - close
```
void close()
```
    Close the associated resources.
    An AmetysObjectIterable must NOT be closed if any of the contained AmetysObject is still in use.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - stream
```
default Stream<A> stream()
```
    Returns a sequential Stream with this iterable as its source.
    
    Returns:
    
    a sequential Stream over the objects in this iterable.
  - spliterator
```
default Spliterator<A> spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<A extends AmetysObject>