com.swirlds.common.wiring.wires.input.NoOpInputWire 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) 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 com.swirlds.common.wiring.model.TraceableWiringModel;
import com.swirlds.common.wiring.schedulers.TaskScheduler;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.function.Consumer;
import java.util.function.Function;

/**
 * An input wire that doesn't actually do anything. When asked to bind a handler, it does nothing. When asked to insert
 * data, it does nothing.
 *
 * @param   the type of data that passes into the wire
 * @param  the type of the primary output wire for the scheduler that is associated with this object
 */
public class NoOpInputWire extends BindableInputWire {
    /**
     * Constructor.
     *
     * @param model         the wiring model containing this input wire
     * @param taskScheduler the scheduler to insert data into
     * @param name          the name of the input wire
     */
    public NoOpInputWire(
            @NonNull final TraceableWiringModel model,
            @NonNull final TaskScheduler taskScheduler,
            @NonNull final String name) {
        super(model, taskScheduler, name);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void bindConsumer(@NonNull final Consumer handler) {
        // intentional no-op
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void bind(@NonNull final Function handler) {
        // intentional no-op
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void put(@NonNull final IN data) {
        // intentional no-op
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean offer(@NonNull final IN data) {
        return true;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void inject(@NonNull final IN data) {
        // intentional no-op
    }
}