org.elasticsearch.cluster.routing

Interface ShardsIterator

All Superinterfaces:

java.lang.Iterable<ShardRouting>

All Known Subinterfaces:

ShardIterator

All Known Implementing Classes:

PlainShardIterator, PlainShardsIterator, SearchShardIterator

public interface ShardsIterator
extends java.lang.Iterable<ShardRouting>

Allows to iterate over unrelated shards.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.util.List<ShardRouting>	getShardRoutings() Returns the ShardRoutings that this shards iterator holds.
int	hashCode()
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, iterator, spliterator

Method Detail

reset

void reset()

Resets the iterator to its initial state.

size

int size()

The number of shard routing instances.

Returns:

number of shard routing instances in this iterator

sizeActive

int sizeActive()

The number of active shard routing instances

Returns:

number of active shard routing instances

nextOrNull

ShardRouting nextOrNull()

Returns the next shard, or null if none available.

remaining

int remaining()

Return the number of shards remaining in this ShardsIterator

Returns:

number of shard remaining

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getShardRoutings

java.util.List<ShardRouting> getShardRoutings()

Returns the ShardRoutings that this shards iterator holds.