Alert.java

package rocks.inspectit.shared.cs.communication.data.cmr;

import java.util.UUID;

import rocks.inspectit.shared.cs.ci.AlertingDefinition;

/**
 * Represents a detected alert.
 *
 * @author Alexander Wert
 *
 */
public class Alert {
	/**
	 * Unique id of the alert.
	 */
	private final String id = UUID.randomUUID().toString();

	/**
	 * {@link AlertingDefinition} this alert belongs to.
	 */
	private AlertingDefinition alertingDefinition;

	/**
	 * The timestamp when the alert began.
	 */
	private long startTimestamp = -1L;

	/**
	 * The timestamp when the alert was gone.
	 */
	private long stopTimestamp = -1L;

	/**
	 * The closing reason.
	 */
	private AlertClosingReason closingReason;

	/**
	 * Default Constructor for serialization.
	 */
	public Alert() {
	}

	/**
	 * Constructor.
	 *
	 * @param alertingDefinition
	 *            {@link AlertingDefinition} this alert belongs to.
	 * @param startTimestamp
	 *            The timestamp when the alert began.
	 * @param stopTimestamp
	 *            The timestamp when the alert was gone.
	 */
	public Alert(AlertingDefinition alertingDefinition, long startTimestamp, long stopTimestamp) {
		this.alertingDefinition = alertingDefinition;
		this.startTimestamp = startTimestamp;
		this.stopTimestamp = stopTimestamp;
	}

	/**
	 * Constructor.
	 *
	 * @param alertingDefinition
	 *            {@link AlertingDefinition} this alert belongs to.
	 * @param startTimestamp
	 *            The timestamp when the alert began.
	 */
	public Alert(AlertingDefinition alertingDefinition, long startTimestamp) {
		this.alertingDefinition = alertingDefinition;
		this.startTimestamp = startTimestamp;
	}

	/**
	 * Closes the alert.
	 *
	 * @param stopTimestamp
	 *            The timestamp when the alert has been closed.
	 * @param closingReason
	 *            The reason why the alert has been closed.
	 */
	public void close(long stopTimestamp, AlertClosingReason closingReason) {
		this.stopTimestamp = stopTimestamp;
		this.closingReason = closingReason;
	}

	/**
	 * Gets {@link #alertingDefinition}.
	 *
	 * @return {@link #alertingDefinition}
	 */
	public AlertingDefinition getAlertingDefinition() {
		return this.alertingDefinition;
	}

	/**
	 * Sets {@link #alertingDefinition}.
	 *
	 * @param alertingDefinition
	 *            New value for {@link #alertingDefinition}
	 */
	public void setAlertingDefinition(AlertingDefinition alertingDefinition) {
		this.alertingDefinition = alertingDefinition;
	}

	/**
	 * Gets {@link #startTimestamp}.
	 *
	 * @return {@link #startTimestamp}
	 */
	public long getStartTimestamp() {
		return this.startTimestamp;
	}

	/**
	 * Sets {@link #startTimestamp}.
	 *
	 * @param startTimestamp
	 *            New value for {@link #startTimestamp}
	 */
	public void setStartTimestamp(long startTimestamp) {
		this.startTimestamp = startTimestamp;
	}

	/**
	 * Gets {@link #stopTimestamp}.
	 *
	 * @return {@link #stopTimestamp}
	 */
	public long getStopTimestamp() {
		return this.stopTimestamp;
	}



	/**
	 * Gets {@link #closingReason}.
	 *
	 * @return {@link #closingReason}
	 */
	public AlertClosingReason getClosingReason() {
		return closingReason;
	}

	/**
	 * Sets {@link #closingReason}.
	 *
	 * @param closingReason
	 *            New value for {@link #closingReason}
	 */
	public void setClosingReason(AlertClosingReason closingReason) {
		this.closingReason = closingReason;
	}

	/**
	 * Gets {@link #id}.
	 *
	 * @return {@link #id}
	 */
	public String getId() {
		return this.id;
	}

	/**
	 * Retrieves the status of the alert.
	 *
	 * @return True, if alerts is open, otherwise false.
	 */
	public boolean isOpen() {
		return getStopTimestamp() < 0;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = (prime * result) + ((this.alertingDefinition == null) ? 0 : this.alertingDefinition.hashCode());
		result = (prime * result) + ((this.closingReason == null) ? 0 : this.closingReason.hashCode());
		result = (prime * result) + ((this.id == null) ? 0 : this.id.hashCode());
		result = (prime * result) + (int) (this.startTimestamp ^ (this.startTimestamp >>> 32));
		result = (prime * result) + (int) (this.stopTimestamp ^ (this.stopTimestamp >>> 32));
		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		Alert other = (Alert) obj;
		if (this.alertingDefinition == null) {
			if (other.alertingDefinition != null) {
				return false;
			}
		} else if (!this.alertingDefinition.equals(other.alertingDefinition)) {
			return false;
		}
		if (this.closingReason != other.closingReason) {
			return false;
		}
		if (this.id == null) {
			if (other.id != null) {
				return false;
			}
		} else if (!this.id.equals(other.id)) {
			return false;
		}
		if (this.startTimestamp != other.startTimestamp) {
			return false;
		}
		if (this.stopTimestamp != other.stopTimestamp) {
			return false;
		}
		return true;
	}

}