org.ametys.plugins.repository

Class NodeIteratorIterable<A extends AmetysObject>

java.lang.Object

org.ametys.plugins.repository.NodeIteratorIterable<A>

Type Parameters:

A - the actual type of AmetysObjects.

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<A>, AmetysObjectIterable<A>

public class NodeIteratorIterable<A extends AmetysObject>
extends Object
implements AmetysObjectIterable<A>

Implementation of AmetysObjectIterable based on a underlying JCR NodeIterator.

Please note that this implementation only works with NodeIterators containing nodes actually bound to AmetysObjects.
If a node exists in the iterator and does not correspond to an AmetysObject, an AmetysRepositoryException will be thrown.
Unless AmetysObjectIterator.skip(long) is called on the underlying Iterator, results are buffered so that one may safely call iterator() more than once, even if the underlying NodeIterator will be consumed only once.
If AmetysObjectIterator.skip(long) is called, any subsequent call to iterator() will throw an IllegalStateException.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	NodeIteratorIterable.NodeIteratorIterator

Field Summary

Fields

Modifier and Type	Field and Description
(package private) List<A>	_buffer
private NodeIterator	_iterator
(package private) String	_parentPath
(package private) AmetysObjectResolver	_resolver
(package private) Session	_session
(package private) boolean	_skipCalled

Constructor Summary

Constructors

Constructor and Description
NodeIteratorIterable(AmetysObjectResolver resolver, NodeIterator iterator, String parentPath, Session session) Creates a NodeIteratorIterable.

Method Summary

Modifier and Type	Method and 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

Field Detail

_resolver

AmetysObjectResolver _resolver

_parentPath

String _parentPath

_session

Session _session

_buffer

List<A extends AmetysObject> _buffer

_skipCalled

boolean _skipCalled

_iterator

private NodeIterator _iterator

Constructor Detail

NodeIteratorIterable

public NodeIteratorIterable(AmetysObjectResolver resolver,
                            NodeIterator iterator,
                            String parentPath,
                            Session session)

Creates a NodeIteratorIterable.

Parameters:

resolver - the application AmetysObjectResolver.

iterator - the underlying NodeIterator.

parentPath - the parent path in the Ametys hierarchy of all AmetysObject being returned.

session - the JCR Session corresponding to the specified NodeIterator

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 Iterable<A extends AmetysObject>

Specified by:

iterator in interface AmetysObjectIterable<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 Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AmetysObjectIterable<A extends AmetysObject>