org.apache.flink.runtime.query.KvStateInfo Maven / Gradle / Ivy

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

import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.runtime.state.internal.InternalKvState;
import org.apache.flink.util.Preconditions;

import java.util.Objects;

/**
 * Metadata about a {@link InternalKvState}. This includes the serializers for
 * the key, the namespace, and the values kept in the state.
 *
 * @param 	The type of key the state is associated to
 * @param 	The type of the namespace the state is associated to
 * @param 	The type of values kept internally in state
 */
public class KvStateInfo {

	private final TypeSerializer keySerializer;
	private final TypeSerializer namespaceSerializer;
	private final TypeSerializer stateValueSerializer;

	public KvStateInfo(
			final TypeSerializer keySerializer,
			final TypeSerializer namespaceSerializer,
			final TypeSerializer stateValueSerializer
	) {
		this.keySerializer = Preconditions.checkNotNull(keySerializer);
		this.namespaceSerializer = Preconditions.checkNotNull(namespaceSerializer);
		this.stateValueSerializer = Preconditions.checkNotNull(stateValueSerializer);
	}

	/**
	 * @return The serializer for the key the state is associated to.
	 */
	public TypeSerializer getKeySerializer() {
		return keySerializer;
	}

	/**
	 * @return The serializer for the namespace the state is associated to.
	 */
	public TypeSerializer getNamespaceSerializer() {
		return namespaceSerializer;
	}

	/**
	 * @return The serializer for the values kept in the state.
	 */
	public TypeSerializer getStateValueSerializer() {
		return stateValueSerializer;
	}

	/**
	 * Creates a deep copy of the current {@link KvStateInfo} by duplicating
	 * all the included serializers.
	 *
	 * This method assumes correct implementation of the {@link TypeSerializer#duplicate()}
	 * method of the included serializers.
	 */
	public KvStateInfo duplicate() {
		final TypeSerializer dupKeySerializer = keySerializer.duplicate();
		final TypeSerializer dupNamespaceSerializer = namespaceSerializer.duplicate();
		final TypeSerializer dupSVSerializer = stateValueSerializer.duplicate();

		if (
			dupKeySerializer == keySerializer &&
			dupNamespaceSerializer == namespaceSerializer &&
			dupSVSerializer == stateValueSerializer
		) {
			return this;
		}

		return new KvStateInfo<>(dupKeySerializer, dupNamespaceSerializer, dupSVSerializer);

	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}
		KvStateInfo stateInfo = (KvStateInfo) o;
		return Objects.equals(keySerializer, stateInfo.keySerializer) &&
				Objects.equals(namespaceSerializer, stateInfo.namespaceSerializer) &&
				Objects.equals(stateValueSerializer, stateInfo.stateValueSerializer);
	}

	@Override
	public int hashCode() {
		return Objects.hash(keySerializer, namespaceSerializer, stateValueSerializer);
	}
}