com.swirlds.common.wiring.wires.input.Bindable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2023-2024 Hedera Hashgraph, LLC
 *
 * 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.swirlds.common.wiring.wires.input;

import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.function.Consumer;
import java.util.function.Function;

/**
 * An object that can be bound to a handler.
 *
 * @param   the type of data that enters
 * @param  the type of data that is permitted to be passed out (non-null values are forwarded to the primary output
 *              wire)
 */
public interface Bindable {

    /**
     * Bind this object to a handler. For things that don't send data to the output wire.
     *
     * @param handler the handler to bind to this input wire
     * @throws IllegalStateException if a handler is already bound and this method is called a second time
     */
    void bindConsumer(@NonNull Consumer handler);

    /**
     * Bind this object to a handler.
     *
     * @param handler the handler to bind to this input task scheduler, values returned are passed to the primary output
     *                wire of the associated scheduler.
     * @throws IllegalStateException if a handler is already bound and this method is called a second time
     */
    void bind(@NonNull final Function handler);
}