org.apache.flink.runtime.state.KeyGroupsList Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation

There is a newer version: 1.19.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.runtime.state;

/** This interface offers ordered random read access to multiple key group ids. */
public interface KeyGroupsList extends Iterable {

    /** Returns the number of key group ids in the list. */
    int getNumberOfKeyGroups();

    /**
     * Returns the id of the keygroup at the given index, where index in interval [0, {@link
     * #getNumberOfKeyGroups()}[.
     *
     * @param idx the index into the list
     * @return key group id at the given index
     */
    int getKeyGroupId(int idx);

    /** Returns true, if the given key group id is contained in the list, otherwise false. */
    boolean contains(int keyGroupId);
}