org.apache.flink.runtime.state.ttl.TtlFoldingState Maven / Gradle / Ivy

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

There is a newer version: 1.13.6

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

import org.apache.flink.api.common.state.AggregatingState;
import org.apache.flink.runtime.state.internal.InternalFoldingState;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * This class wraps folding state with TTL logic.
 *
 * @param  Type of the values folded into the state
 * @param  Type of the value in the state
 *
 * @deprecated use {@link AggregatingState} instead
 */
@Deprecated
class TtlFoldingState
	extends AbstractTtlState, InternalFoldingState>>
	implements InternalFoldingState {
	TtlFoldingState(TtlStateContext>, ACC> ttlStateContext) {
		super(ttlStateContext);
	}

	@Override
	public ACC get() throws Exception {
		accessCallback.run();
		return getInternal();
	}

	@Override
	public void add(T value) throws Exception {
		accessCallback.run();
		original.add(value);
	}

	@Nullable
	@Override
	public TtlValue getUnexpiredOrNull(@Nonnull TtlValue ttlValue) {
		return expired(ttlValue) ? null : ttlValue;
	}

	@Override
	public void clear() {
		original.clear();
	}

	@Override
	public ACC getInternal() throws Exception {
		return getWithTtlCheckAndUpdate(original::getInternal, original::updateInternal);
	}

	@Override
	public void updateInternal(ACC valueToStore) throws Exception {
		original.updateInternal(wrapWithTs(valueToStore));
	}
}