io.jbotsim.core.Message Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbotsim-core Show documentation
JBotSim's core files.
There is a newer version: 1.2.0
/*
 * Copyright 2008 - 2019, Arnaud Casteigts and the JBotSim contributors 
 *
 *
 * This file is part of JBotSim.
 *
 * JBotSim is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JBotSim is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JBotSim.  If not, see .
 *
 */
package io.jbotsim.core;


import java.util.HashMap;

/**
 * The {@link Message} object simply encode a message exchanged by two {@link Node}s.
 */
public final class Message extends Properties {
    protected Node sender;
    protected Node destination;
    protected Object content;
    protected boolean retryMode;
    protected String flag;

    /**
     * Default constructor with empty content
     */
    public Message() {
        this(null, null, "");
    }

    /**
     * @param content The content of this message. It may be an object of any class, whose
     *                reference is going to be shared between sender and destination (no copy).
     */
    public Message(Object content) {
        this(null, null, content);
    }

    /**
     * @param content The content of this message. It may be an object of any class, whose
     *                reference is going to be shared between sender and destination (no copy).
     * @param flag    A custom flag for this message
     */
    public Message(Object content, String flag) {
        this(null, null, content, flag);
    }

    /**
     * Custom constructor
     *
     * @param sender      The sender of the message
     * @param destination The destination of the message
     * @param content     The content of this message. It may be an object of any class, whose
     *                    reference is going to be shared between sender and destination (no copy).
     */
    Message(Node sender, Node destination, Object content) {
        this.sender = sender;
        this.destination = destination;
        this.content = content;
        this.flag = content.getClass().toString();
    }

    /**
     * Custom constructor
     *
     * @param sender      The sender of the message
     * @param destination The destination of the message
     * @param content     The content of this message. It may be an object of any class, whose
     *                    reference is going to be shared between sender and destination (no copy).
     * @param flag        A custom flag for this message
     */
    Message(Node sender, Node destination, Object content, String flag) {
        this.sender = sender;
        this.destination = destination;
        this.content = content;
        this.flag = flag;
    }

    /**
     * Copy constructor.
     *
     * @param message The original message to be copied.
     */
    public Message(Message message) {
        this(message.getSender(), message.getDestination(), message);
    }

    /**
     * Copy constructor with custom sender and destination.
     *
     * @param sender      The new sender of the message.
     * @param destination The new destination of the message.
     * @param message     The original message to be copied.
     */
    Message(Node sender, Node destination, Message message) {
        this.sender = sender;
        this.destination = destination;
        this.content = message.content;
        this.retryMode = message.retryMode;
        this.flag = message.flag;
        this.properties = new HashMap<>(message.properties);
    }

    /**
     * Copy the current message, changing only the destination.
     *
     * @param newDestination The new destination of the message.
     * @return the new {@link Message} object.
     */
    public Message withDestination(Node newDestination) {
        return new Message(this.getSender(), newDestination, this);
    }

    /**
     * The sender of this message.
     * @return the {@link Node} registered as the sender of the message.
     */
    public Node getSender() {
        return sender;
    }

    /**
     * The destination of this message.
     * @return the {@link Node} registered as the destination of the message.
     */
    public Node getDestination() {
        return destination;
    }

    /**
     * The content of this message, which may be an object of any class.
     * @return the content of the message, as an {@link Object}.
     */
    public Object getContent() {
        return content;
    }

    /**
     * The flag of this message.
     * @return the flag of this message, as a {@link String}.
     */
    public String getFlag() {
        return flag;
    }

    @Override
    public String toString() {
        return sender + " -> " + destination + ": " + content;
    }
}