cc.redberry.pipe.InputPort.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pipe Show documentation

Java library for implementation of concurrent pipelines.

The newest version!

/*
 * Copyright (c) 2022 MiLaboratories Inc.
 *
 * 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 cc.redberry.pipe

/**
 * Base interface for passive object consumer.
 *
 * @param  type of consumed objects
 * @author Bolotin Dmitriy ([email protected])
 */
interface InputPort {
    /**
     * Put an element into this input port.
     *
     *
     * Putting of `null` is allowed only once and this indicates that the port should be **closed**. No
     * invocations of this method allowed for **closed** input port.
     *
     * @param `object` object to put into this input port, or `null` if port should be closed
     */
    fun put(obj: T?)

    companion object {
        inline operator fun  invoke(crossinline function: (T?) -> Unit) =
            object : InputPort {
                override fun put(obj: T?) {
                    function(obj)
                }
            }
    }
}