Interface ShardsIterator

All Superinterfaces:
Countable, Iterable<ShardRouting>
All Known Subinterfaces:
All Known Implementing Classes:
PlainShardIterator, PlainShardsIterator

public interface ShardsIterator extends Iterable<ShardRouting>, Countable
Allows to iterate over unrelated shards.
  • Method Details

    • reset

      void reset()
      Resets the iterator to its initial state.
    • size

      int size()
      The number of shard routing instances.
      Specified by:
      size in interface Countable
      number of shard routing instances in this iterator
    • sizeActive

      int sizeActive()
      The number of active shard routing instances
      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
      number of shard remaining
    • hashCode

      int hashCode()
      hashCode in class Object
    • equals

      boolean equals(Object other)
      equals in class Object
    • getShardRoutings

      List<ShardRouting> getShardRoutings()
      Returns the ShardRoutings that this shards iterator holds.