org.apache.flink.runtime.state.context.ContextKeyedState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation

The newest version!

/*
 * 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.context;

import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.runtime.state.VoidNamespace;
import org.apache.flink.runtime.state.VoidNamespaceSerializer;
import org.apache.flink.runtime.state.internal.InternalKvState;
import org.apache.flink.runtime.state.keyed.KeyedState;

/**
 * Interface for user-facing state which is backed by {@link KeyedState}.
 */
public interface ContextKeyedState extends InternalKvState {

	/**
	 * Returns the backed {@link KeyedState}.
	 */
	KeyedState getKeyedState();

	@Override
	default void setCurrentNamespace(VoidNamespace namespace) {
		if (!VoidNamespace.INSTANCE.equals(namespace)) {
			throw new UnsupportedOperationException("setCurrentNamespace should not be called within keyed state.");
		}
	}

	@Override
	default TypeSerializer getNamespaceSerializer() {
		return VoidNamespaceSerializer.INSTANCE;
	}
}