org.phoebus.applications.alarm.model.BasicState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of app-alarm-model Show documentation

The newest version!

/*******************************************************************************
 * Copyright (c) 2018 Oak Ridge National Laboratory.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/
package org.phoebus.applications.alarm.model;

import java.util.Objects;

/** Basic state held by every node in the alarm hierarchy
 *  @author Kay Kasemir
 */
public class BasicState
{
    /** Alarm severity */
    public final SeverityLevel severity;

    /** @param severity Alarm severity */
    public BasicState(final SeverityLevel severity)
    {
        this.severity = Objects.requireNonNull(severity);
    }

    /** @return Severity level of alarm */
    public SeverityLevel getSeverity()
    {
        return severity;
    }

    @Override
    public int hashCode()
    {
        return severity.hashCode();
    }

    @Override
    public boolean equals(Object obj)
    {
        if (! (obj instanceof BasicState))
            return false;
        final BasicState other = (BasicState) obj;
        return severity == other.severity;
    }

    @Override
    public String toString()
    {
        return severity.name();
    }
}