org.opentcs.access.NotificationPublicationEvent Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.access;

import java.io.Serializable;
import static java.util.Objects.requireNonNull;
import org.opentcs.data.notification.UserNotification;

/**
 * Instances of this class represent events emitted by/for notifications being published.
 *
 * @author Stefan Walter (Fraunhofer IML)
 */
public class NotificationPublicationEvent
    implements Serializable {

  /**
   * The published message.
   */
  private final UserNotification notification;

  /**
   * Creates a new instance.
   *
   * @param message The message being published.
   */
  public NotificationPublicationEvent(UserNotification message) {
    this.notification = requireNonNull(message, "notification");
  }

  /**
   * Returns the message being published.
   *
   * @return The message being published.
   */
  public UserNotification getNotification() {
    return notification;
  }

  @Override
  public String toString() {
    return getClass().getSimpleName()
        + '{'
        + "notification=" + notification
        + '}';
  }
}