org.apache.kafka.streams.kstream.ValueTransformerWithKeySupplier 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.kafka.streams.kstream;

import org.apache.kafka.streams.processor.ConnectedStoreProvider;

import java.util.function.Supplier;

/**
 * A {@code ValueTransformerWithKeySupplier} interface which can create one or more {@link ValueTransformerWithKey} instances.
 * 
 * The supplier should always generate a new instance each time {@link ValueTransformerWithKeySupplier#get()} gets called. Creating
 * a single {@link ValueTransformerWithKey} object and returning the same object reference in {@link ValueTransformerWithKeySupplier#get()} would be
 * a violation of the supplier pattern and leads to runtime exceptions.
 *
 * @param   key type
 * @param   value type
 * @param  transformed value type
 * @see ValueTransformer
 * @see ValueTransformerWithKey
 * @see KStream#transformValues(ValueTransformerSupplier, String...)
 * @see KStream#transformValues(ValueTransformerWithKeySupplier, String...)
 * @see Transformer
 * @see TransformerSupplier
 * @see KStream#transform(TransformerSupplier, String...)
 */
public interface ValueTransformerWithKeySupplier extends ConnectedStoreProvider, Supplier> {

    /**
     * Return a newly constructed {@link ValueTransformerWithKey} instance.
     * The supplier should always generate a new instance each time {@link  ValueTransformerWithKeySupplier#get()} gets called.
     * 
     * Creating a single {@link ValueTransformerWithKey} object and returning the same object reference in {@link ValueTransformerWithKeySupplier#get()}
     * is a violation of the supplier pattern and leads to runtime exceptions.
     *
     * @return  a new {@link ValueTransformerWithKey} instance
     * @return  a newly constructed {@link ValueTransformerWithKey} instance
     */
    ValueTransformerWithKey get();
}