org.elasticsearch.cluster.routing

Interface ShardsIterator

All Known Subinterfaces:

ShardIterator

All Known Implementing Classes:

PlainShardIterator, PlainShardsIterator

public interface ShardsIterator

Allows to iterate over unrelated shards.

Method Summary

Methods

Modifier and Type	Method and Description
int	assignedReplicasIncludingRelocating() Returns the number of replicas in this iterator that are not in the ShardRoutingState.UNASSIGNED.
Iterable<ShardRouting>	asUnordered()
boolean	equals(Object other)
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

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

assignedReplicasIncludingRelocating

int assignedReplicasIncludingRelocating()

Returns the number of replicas in this iterator that are not in the ShardRoutingState.UNASSIGNED. The returned double-counts replicas that are in the state ShardRoutingState.RELOCATING

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 Object

equals

boolean equals(Object other)

Overrides:

equals in class Object

asUnordered

Iterable<ShardRouting> asUnordered()