Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing

Class ShardIterator

java.lang.Object

org.elasticsearch.common.util.PlainIterator<ShardRouting>

org.elasticsearch.cluster.routing.PlainShardsIterator

org.elasticsearch.cluster.routing.ShardIterator

All Implemented Interfaces:

Comparable<ShardIterator>, Iterable<ShardRouting>, ShardsIterator

Direct Known Subclasses:

SearchShardRouting

public sealed class ShardIterator
extends PlainShardsIterator
implements Comparable<ShardIterator>
permits SearchShardRouting

The ShardIterator is a ShardsIterator which iterates all shards of a given shard id

Constructor Summary

Constructors

Constructor	Description
ShardIterator(ShardId shardId, List<ShardRouting> shards)	Creates a ShardIterator instance that iterates all shards of a given shardId.

Method Summary

Modifier and Type	Method	Description
static ShardIterator	allSearchableShards(ShardIterator shardIterator)
int	compareTo(ShardIterator o)
boolean	equals(Object o)
int	hashCode()
ShardId	shardId()	The shard id this group relates to.

Methods inherited from class org.elasticsearch.cluster.routing.PlainShardsIterator

getShardRoutings, sizeActive

Methods inherited from class org.elasticsearch.common.util.PlainIterator

asList, iterator, nextOrNull, remaining, reset, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

nextOrNull

Constructor Details

ShardIterator

public ShardIterator(ShardId shardId,
 List<ShardRouting> shards)

Creates a ShardIterator instance that iterates all shards of a given shardId.

Parameters:

shardId - shard id of the group

shards - shards to iterate

Method Details

allSearchableShards

public static ShardIterator allSearchableShards(ShardIterator shardIterator)

shardId

public ShardId shardId()

The shard id this group relates to.

equals

public boolean equals(Object o)

Specified by:

equals in interface ShardsIterator

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface ShardsIterator

Overrides:

hashCode in class Object

compareTo

public int compareTo(ShardIterator o)

Specified by:

compareTo in interface Comparable<ShardIterator>