PlainShardIterator (server 7.0.1 API)

java.lang.Object
- org.elasticsearch.cluster.routing.PlainShardsIterator
- - org.elasticsearch.cluster.routing.PlainShardIterator

All Implemented Interfaces:

java.lang.Comparable<ShardIterator>, java.lang.Iterable<ShardRouting>, ShardIterator, ShardsIterator

Direct Known Subclasses:

SearchShardIterator
```
public class PlainShardIterator
extends PlainShardsIterator
implements ShardIterator
```
The PlainShardIterator is a ShardsIterator which iterates all shards or a given shard id

Constructor Summary

Constructors
Constructor	Description
`PlainShardIterator(ShardId shardId, java.util.List<ShardRouting> shards)`	Creates a `PlainShardIterator` instance that iterates over a subset of the given shards this the a given `shardId`.

Method Summary

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

Methods inherited from class org.elasticsearch.cluster.routing.PlainShardsIterator
getShardRoutings, iterator, nextOrNull, remaining, reset, size, sizeActive

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.ShardIterator
reset

Methods inherited from interface org.elasticsearch.cluster.routing.ShardsIterator
getShardRoutings, nextOrNull, remaining, size, sizeActive

- Constructor Detail
  - PlainShardIterator
```
public PlainShardIterator(ShardId shardId,
                          java.util.List<ShardRouting> shards)
```
    Creates a PlainShardIterator instance that iterates over a subset of the given shards this the a given shardId.
    
    Parameters:
    
    shardId - shard id of the group
    
    shards - shards to iterate
- Method Detail
  - shardId
```
public ShardId shardId()
```
    Description copied from interface: ShardIterator
    
    The shard id this group relates to.
    
    Specified by:
    
    shardId in interface ShardIterator
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface ShardsIterator
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface ShardsIterator
    
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(ShardIterator o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<ShardIterator>