EventSeverity.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2, as
 * published by the Free Software Foundation, and/or the GNU Lesser
 * General Public License, version 2.1, also as published by the Free
 * Software Foundation.
 *
 * This program 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 General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.rhq.core.domain.event;

/**
 * The severity of an {@link Event}. Values are ordered from least to most severe.
 */
public enum EventSeverity {

    DEBUG, INFO, WARN, ERROR, FATAL;

    /**
     * Determine if this severity is more severe than that of other
     * @param other EventSeverity to compare
     * @return if more severe
     */
    public boolean isMoreSevereThan(EventSeverity other) {
        if (other == null) // If other is null, our severity is always higher
            return true;

        return (ordinal() > other.ordinal());
    }

    /**
     * Determine if this severity is at least as severe as that of other
     * @param other EventSeverity to compare
     * @return if at least as severe
     */
    public boolean isAtLeastAsSevereAs(EventSeverity other) {
        if (other == null) // If other is null, our severity is always higher
            return true;

        return (ordinal() >= other.ordinal());
    }

    /**
     * Getter for use in JSP pages
     * @return the same value as {@link EventSeverity#ordinal()}
     */
    public int getOrdinal() {
        return ordinal();
    }

    public EventSeverity[] getValues() {
        return values();
    }

    public String toString() {
        return name();
    }
}