io.mokamint.application.messages.DeliverTransactionMessages Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io-mokamint-application-messages Show documentation

This module implements the messages exchanged between an application and a Mokamint node.

The newest version!

/*
Copyright 2024 Fausto Spoto

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 io.mokamint.application.messages;

import io.mokamint.application.messages.api.DeliverTransactionMessage;
import io.mokamint.application.messages.internal.DeliverTransactionMessageImpl;
import io.mokamint.application.messages.internal.gson.DeliverTransactionMessageDecoder;
import io.mokamint.application.messages.internal.gson.DeliverTransactionMessageEncoder;
import io.mokamint.application.messages.internal.gson.DeliverTransactionMessageJson;
import io.mokamint.node.api.Transaction;

/**
 * A provider of {@link DeliverTransactionMessage}.
 */
public final class DeliverTransactionMessages {

	private DeliverTransactionMessages() {}

	/**
	 * Yields a {@link DeliverTransactionMessage}.
	 * 
	 * @param groupId the identifier of the group of transactions in the message
	 * @param transaction the transaction in the message
	 * @param id the identifier of the message
	 * @return the message
	 */
	public static DeliverTransactionMessage of(int groupId, Transaction transaction, String id) {
		return new DeliverTransactionMessageImpl(groupId, transaction, id);
	}

	/**
	 * Gson encoder.
	 */
	public static class Encoder extends DeliverTransactionMessageEncoder {

		/**
		 * Creates a new encoder.
		 */
		public Encoder() {}
	}

	/**
	 * Gson decoder.
	 */
	public static class Decoder extends DeliverTransactionMessageDecoder {

		/**
		 * Creates a new decoder.
		 */
		public Decoder() {}
	}

	/**
     * Json representation.
     */
    public static class Json extends DeliverTransactionMessageJson {

    	/**
    	 * Creates the Json representation for the given message.
    	 * 
    	 * @param message the message
    	 */
    	public Json(DeliverTransactionMessage message) {
    		super(message);
    	}
    }
}