com.jgoodies.validation.Severity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jgoodies-validation Show documentation

The JGoodies Validation helps you validate user input in Swing apps and report validation errors and warnings. It has been designed to work with different architectures and programming flavors.

The newest version!

/*
 * Copyright (c) 2003-2014 JGoodies Software GmbH. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  o Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *  o Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 *  o Neither the name of JGoodies Software GmbH nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.jgoodies.validation;



/**
 * An enumeration for the severities used in {@link ValidationMessage}.
 * Useful to categorize validation results, for example to prevent an object
 * from being saved if the primary key is missing.
 *
 * The severity is used in almost all views that present validation messages
 * and is used in operations on instances of
 * {@link com.jgoodies.validation.ValidationResult}.
 *
 * @author  Karsten Lentzsch
 * @version $Revision: 1.10 $
 *
 * @see com.jgoodies.validation.ValidationMessage
 * @see com.jgoodies.validation.ValidationResult
 */
public enum Severity {

    /**
     * Indicates a problem that cannot be resumed or worked around.
     * For example it prevents an edited value to be saved.
     */
    ERROR,

    /**
     * Indicates a problem that can be resumed or handled in
     * a reasonable way. For example a field value may break
     * a constraint but the object can be temporarily saved.
     */
    WARNING,

    /**
     * Indicates a useful additional information about a value.
     */
    INFO,

    /**
     * Returned by empty validation results to indicate that
     * no problem has been detected, or in other words, everything is fine.
     */
    OK;



    /**
     * Returns the higher of the given severities by comparing their ordinals.
     * Since the higher severities have a lower ordinal, this method returns
     * the severity with the lower ordinal.
     *
     * @param severity1  the first severity to check
     * @param severity2  the second severity to check
     * @return the higher of the given severities
     */
    public static Severity max(Severity severity1, Severity severity2) {
        return severity1.ordinal() < severity2.ordinal()
            ? severity1
            : severity2;
    }


}