org.apache.flink.runtime.state.GenericListState 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.state;
import org.apache.flink.api.common.state.ListState;
import org.apache.flink.api.common.state.ListStateDescriptor;
import org.apache.flink.api.common.state.ValueState;
import org.apache.flink.api.common.state.ValueStateDescriptor;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import java.io.IOException;
import java.util.ArrayList;
/**
* Generic implementation of {@link ListState} based on a wrapped {@link ValueState}.
*
* @param The type of the key.
* @param The type of the namespace.
* @param The type of the values stored in this {@code ListState}.
* @param The type of {@link AbstractStateBackend} that manages this {@code KvState}.
* @param Generic type that extends both the underlying {@code ValueState} and {@code KvState}.
*/
public class GenericListState> & KvState>, ValueStateDescriptor>, Backend>>
implements ListState, KvState, ListStateDescriptor, Backend> {
private final W wrappedState;
/**
* Creates a new {@code ListState} that wraps the given {@link ValueState}. The
* {@code ValueState} must have a default value of {@code null}.
*
* @param wrappedState The wrapped {@code ValueState}
*/
@SuppressWarnings("unchecked")
public GenericListState(ValueState> wrappedState) {
if (!(wrappedState instanceof KvState)) {
throw new IllegalArgumentException("Wrapped state must be a KvState.");
}
this.wrappedState = (W) wrappedState;
}
@Override
public void setCurrentKey(K key) {
wrappedState.setCurrentKey(key);
}
@Override
public void setCurrentNamespace(N namespace) {
wrappedState.setCurrentNamespace(namespace);
}
@Override
public KvStateSnapshot, ListStateDescriptor, Backend> snapshot(
long checkpointId,
long timestamp) throws Exception {
KvStateSnapshot>, ValueStateDescriptor>, Backend> wrappedSnapshot = wrappedState.snapshot(
checkpointId,
timestamp);
return new Snapshot<>(wrappedSnapshot);
}
@Override
public void dispose() {
wrappedState.dispose();
}
@Override
public Iterable get() throws Exception {
return wrappedState.value();
}
@Override
public void add(T value) throws Exception {
ArrayList currentValue = wrappedState.value();
if (currentValue == null) {
currentValue = new ArrayList<>();
currentValue.add(value);
wrappedState.update(currentValue);
} else {
currentValue.add(value);
wrappedState.update(currentValue);
}
}
@Override
public void clear() {
wrappedState.clear();
}
private static class Snapshot implements KvStateSnapshot, ListStateDescriptor, Backend> {
private static final long serialVersionUID = 1L;
private final KvStateSnapshot>, ValueStateDescriptor>, Backend> wrappedSnapshot;
public Snapshot(KvStateSnapshot>, ValueStateDescriptor>, Backend> wrappedSnapshot) {
this.wrappedSnapshot = wrappedSnapshot;
}
@Override
@SuppressWarnings("unchecked")
public KvState, ListStateDescriptor, Backend> restoreState(
Backend stateBackend,
TypeSerializer keySerializer,
ClassLoader classLoader) throws Exception {
return new GenericListState((ValueState) wrappedSnapshot.restoreState(stateBackend, keySerializer, classLoader));
}
@Override
public void discardState() throws Exception {
wrappedSnapshot.discardState();
}
@Override
public long getStateSize() throws Exception {
return wrappedSnapshot.getStateSize();
}
@Override
public void close() throws IOException {
wrappedSnapshot.close();
}
}
}