com.swirlds.common.wiring.transformers.AdvancedTransformation 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
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.
/*
* 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.transformers;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
/**
* Executes a transformation for an advanced transformer as created by
* {@link com.swirlds.common.wiring.wires.output.OutputWire#buildAdvancedTransformer(AdvancedTransformation)}.
*
* @param the original wire output type
* @param the output type of the transformer
*/
public interface AdvancedTransformation {
/**
* Given data that comes off of the original output wire, this method transforms it before it is passed to each
* input wire that is connected to this transformer. Called once per data element per listener.
*
* @param a a data element from the original output wire
* @return the transformed data element, or null if the data should not be forwarded
*/
@Nullable
B transform(@NonNull A a);
/**
* Called on the original data element after it has been forwarded to all listeners. This method can do cleanup if
* necessary. Doing nothing is perfectly ok if the use case does not require cleanup.
*
* @param a the original data element
*/
void inputCleanup(@NonNull A a);
/**
* Called on the transformed data element if it is rejected by a listener. This is possible if offer soldering is
* used and the destination declines to take the data.
*
* @param b the transformed data element
*/
void outputCleanup(@NonNull B b);
/**
* @return the name of this transformer
*/
@NonNull
String getTransformerName();
/**
* Return the name of the input wire that feeds data into this transformer.
*
* @return the name of the input wire
*/
@NonNull
String getTransformerInputName();
}