storm-client/src/jvm/org/apache/storm/streams/processors/StatefulProcessor.java

/**
 * 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.storm.streams.processors;

import org.apache.storm.state.KeyValueState;

/**
 * Top level interface for processors that does stateful processing.
 *
 * @param <K> the key type
 * @param <V> the value type
 */
public interface StatefulProcessor<K, V> {
    /**
     * Initialize the state of the processor with the given {@link KeyValueState}.
     *
     * @param keyValueState the key-value state
     */
    void initState(KeyValueState<K, V> keyValueState);
}