net.roboconf.messaging.messages.from_dm_to_dm.MsgEcho Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of roboconf-messaging Show documentation
The newest version!
/**
 * Copyright 2015 Linagora, Université Joseph Fourier, Floralis
 *
 * The present code is developed in the scope of the joint LINAGORA -
 * Université Joseph Fourier - Floralis research program and is designated
 * as a "Result" pursuant to the terms and conditions of the LINAGORA
 * - Université Joseph Fourier - Floralis research program. Each copyright
 * holder of Results enumerated here above fully & independently holds complete
 * ownership of the complete Intellectual Property rights applicable to the whole
 * of said Results, and may freely exploit it in any manner which does not infringe
 * the moral rights of the other copyright holders.
 *
 * 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 net.roboconf.messaging.messages.from_dm_to_dm;

import java.util.Objects;
import java.util.UUID;

import net.roboconf.messaging.messages.Message;

/**
 * A message sent on the DM debug queue.
 * @author Pierre bourret - Université Joseph Fourier
 */
public class MsgEcho extends Message {

	private static final long serialVersionUID = 3568910235669142258L;

	// The content of the message
	private final String content;

	// The expiration time of this message.
	private final long expirationTime;

	// The message UUID. May be manually set to identity a message session (e.g. ping response)
	private final UUID uuid;

	/**
	 * Constructs an Echo message with the given content.
	 *
	 * @param content the content of the Echo message.
	 * @param expirationTime the expiration time of the message, e.g. {@code System.currentTimeMillis() + timeout}.
	 * @throws java.lang.NullPointerException if {@code content} is {@code null}.
	 */
	public MsgEcho( String content, long expirationTime ) {
		Objects.requireNonNull( content, "content is null" );
		this.content = content;
		this.expirationTime = expirationTime;
		this.uuid = UUID.randomUUID();
	}

	/**
	 * Constructs an Echo message with the given content.
	 *
	 * @param content the content of the Echo message.
	 * @param expirationTime the expiration time of the message, e.g. {@code System.currentTimeMillis() + timeout}.
	 * @param uuid the manually fixed UUID.
	 * @throws java.lang.NullPointerException if {@code content} or {@code uuid} is {@code null}.
	 */
	public MsgEcho( String content, long expirationTime, UUID uuid ) {
		Objects.requireNonNull( content, "content is null" );
		Objects.requireNonNull( uuid, "uuid is null" );
		this.content = content;
		this.expirationTime = expirationTime;
		this.uuid = uuid;
	}

	/**
	 * @return the content of this message.
	 */
	public final String getContent() {
		return this.content;
	}

	/**
	 * @return the expiration time of this message.
	 */
	public final long getExpirationTime() {
		return this.expirationTime;
	}

	/**
	 * @return the content of this message.
	 */
	public final UUID getUuid() {
		return this.uuid;
	}

	@Override
	public String toString() {
		return this.content;
	}
}