Package org.ametys.plugins.repository

Class CollatingUniqueAmetysObjectIterable<A extends AmetysObject>

java.lang.Object

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

Type Parameters:

A - the actual type of AmetysObjects.

All Implemented Interfaces:

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

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

Implementation of a AmetysObjectIterable based on a list of others AmetysObjectIterable, which returns the objects in a given order, removing duplicates. Each iterable must be sorted. The "collating" part is copied and adapted from Apache Commons Lang's CollatingIterator class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	CollatingUniqueAmetysObjectIterable.CollatingIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Comparator<A>	_comparator	The Comparator used to evaluate order.
private List<AmetysObjectIterable<A>>	_iterables	The list of iterables.

Constructor Summary

Constructors

Constructor	Description
CollatingUniqueAmetysObjectIterable(List<AmetysObjectIterable<A>> iterables, Comparator<A> comparator)	Creates a CollatingUniqueAmetysObjectIterable.

Method Summary

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 only if there is only one AmetysObjectIterable in the list.
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

_comparator

Comparator<A extends AmetysObject> _comparator

The Comparator used to evaluate order.

_iterables

private List<AmetysObjectIterable<A extends AmetysObject>> _iterables

The list of iterables.

Constructor Detail

CollatingUniqueAmetysObjectIterable

public CollatingUniqueAmetysObjectIterable(List<AmetysObjectIterable<A>> iterables,
                                           Comparator<A> comparator)

Creates a CollatingUniqueAmetysObjectIterable.

Parameters:

iterables - a list of AmetysObjectIterable.

comparator - a comparator.

Method Detail

getSize

public long getSize()

Returns the number of elements only if there is only one AmetysObjectIterable in the list. If there is more than 1 AmetysObjectIterable, this always returns -1.

Specified by:

getSize in interface AmetysObjectIterable<A extends AmetysObject>

Returns:

The size of the unique iterable or -1 if there is more than 1 iterable.

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