org.apache.flink.runtime.state

Interface KeyGroupsList

All Superinterfaces:

Iterable<Integer>

All Known Implementing Classes:

KeyGroupRange

public interface KeyGroupsList
extends Iterable<Integer>

This interface offers ordered random read access to multiple key group ids.

Method Summary

Modifier and Type	Method and Description
boolean	contains(int keyGroupId) Returns true, if the given key group id is contained in the list, otherwise false.
int	getKeyGroupId(int idx) Returns the id of the keygroup at the given index, where index in interval [0, getNumberOfKeyGroups()[.
int	getNumberOfKeyGroups() Returns the number of key group ids in the list.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getNumberOfKeyGroups

int getNumberOfKeyGroups()

Returns the number of key group ids in the list.

getKeyGroupId

int getKeyGroupId(int idx)

Returns the id of the keygroup at the given index, where index in interval [0, getNumberOfKeyGroups()[.

Parameters:

idx - the index into the list

Returns:

key group id at the given index

contains

boolean contains(int keyGroupId)

Returns true, if the given key group id is contained in the list, otherwise false.