CollectionIterable (Ametys 4.5.x - API)

java.lang.Object
- org.ametys.plugins.repository.CollectionIterable<A>

Type Parameters:

A - the actual type of AmetysObjects

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<A>, AmetysObjectIterable<A>
```
public class CollectionIterable<A extends AmetysObject>
extends Object
implements AmetysObjectIterable<A>
```
Basic implementation of an AmetysObjectIterable based on an existing Collection.

Constructor Summary

Constructors
Constructor Description

CollectionIterable(Collection<A> collection)
Creates a CollectionIterable.

Method Summary

All Methods Instance Methods Concrete 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()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObjectIterable
spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - CollectionIterable
```
public CollectionIterable(Collection<A> collection)
```
    Creates a CollectionIterable.
    
    Parameters:
    
    collection - the AmetysObjects collection
- Method Detail
  - getSize
```
public long getSize()
```
    Description copied from interface: AmetysObjectIterable
    
    Returns the number of elements in this iterable. If this information is unavailable, returns -1.
    
    Specified by:
    
    getSize in interface AmetysObjectIterable<A extends AmetysObject>
    
    Returns:
    
    a long
  - iterator
```
public AmetysObjectIterator<A> iterator()
```
    Specified by:
    
    iterator in interface AmetysObjectIterable<A extends AmetysObject>
    
    Specified by:
    
    iterator in interface Iterable<A extends AmetysObject>
  - close
```
public void close()
```
    Description copied from interface: AmetysObjectIterable
    
    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 AmetysObjectIterable<A extends AmetysObject>
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable