Package org.elasticsearch.cluster.routing

Class PlainShardsIterator

java.lang.Object

org.elasticsearch.cluster.routing.PlainShardsIterator

All Implemented Interfaces:

java.lang.Iterable<ShardRouting>, ShardsIterator

Direct Known Subclasses:

PlainShardIterator

public class PlainShardsIterator
extends java.lang.Object
implements ShardsIterator

A simple ShardsIterator that iterates a list or sub-list of shard routings.

Constructor Summary

Constructors

Constructor	Description
PlainShardsIterator(java.util.List<ShardRouting> shards)

Method Summary

Modifier and Type	Method	Description
java.util.List<ShardRouting>	getShardRoutings()	Returns the ShardRoutings that this shards iterator holds.
java.util.Iterator<ShardRouting>	iterator()
ShardRouting	nextOrNull()	Returns the next shard, or null if none available.
int	remaining()	Return the number of shards remaining in this ShardsIterator
void	reset()	Resets the iterator to its initial state.
int	size()	The number of shard routing instances.
int	sizeActive()	The number of active shard routing instances

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.routing.ShardsIterator

equals, hashCode

Constructor Detail

PlainShardsIterator

public PlainShardsIterator(java.util.List<ShardRouting> shards)

Method Detail

reset

public void reset()

Description copied from interface: ShardsIterator

Resets the iterator to its initial state.

Specified by:

reset in interface ShardsIterator

remaining

public int remaining()

Description copied from interface: ShardsIterator

Return the number of shards remaining in this ShardsIterator

Specified by:

remaining in interface ShardsIterator

Returns:

number of shard remaining

nextOrNull

public ShardRouting nextOrNull()

Description copied from interface: ShardsIterator

Returns the next shard, or null if none available.

Specified by:

nextOrNull in interface ShardsIterator

size

public int size()

Description copied from interface: ShardsIterator

The number of shard routing instances.

Specified by:

size in interface ShardsIterator

Returns:

number of shard routing instances in this iterator

sizeActive

public int sizeActive()

Description copied from interface: ShardsIterator

The number of active shard routing instances

Specified by:

sizeActive in interface ShardsIterator

Returns:

number of active shard routing instances

getShardRoutings

public java.util.List<ShardRouting> getShardRoutings()

Description copied from interface: ShardsIterator

Returns the ShardRoutings that this shards iterator holds.

Specified by:

getShardRoutings in interface ShardsIterator

iterator

public java.util.Iterator<ShardRouting> iterator()

Specified by:

iterator in interface java.lang.Iterable<ShardRouting>