com.hazelcast.mapreduce.Context Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed 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 com.hazelcast.mapreduce;

import com.hazelcast.spi.annotation.Beta;

/**
 * The Context interface is used for emitting keys and values to the intermediate working space of
 * the MapReduce algorithm.
 *
 * @param  key type of the resulting keys
 * @param  value type of the resulting values
 * @since 3.2
 */
@Beta
public interface Context {

    /**
     * Emits a key-value pair to the intermediate working space. The same key can be used multiple
     * times to collect values under the same key.
     *
     * @param key   emitted key to the intermediate working space.
     * @param value emitted value to the intermediate working space.
     */
    void emit(K key, V value);

}