io.mokamint.application.messages.KeepFromMessages 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 java.time.LocalDateTime;

import io.mokamint.application.messages.api.KeepFromMessage;
import io.mokamint.application.messages.internal.KeepFromMessageImpl;
import io.mokamint.application.messages.internal.gson.KeepFromMessageDecoder;
import io.mokamint.application.messages.internal.gson.KeepFromMessageEncoder;
import io.mokamint.application.messages.internal.gson.KeepFromMessageJson;

/**
 * A provider of {@link KeepFromMessage}.
 */
public final class KeepFromMessages {

	private KeepFromMessages() {}

	/**
	 * Yields a {@link KeepFromMessage}.
	 * 
	 * @param start the limit time, before which states can be garbage-collected, present in the message
	 * @param id the identifier of the message
	 * @return the message
	 */
	public static KeepFromMessage of(LocalDateTime start, String id) {
		return new KeepFromMessageImpl(start, id);
	}

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

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

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

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

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

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