01: /*
02: * Copyright (c) 2003-2007 JGoodies Karsten Lentzsch. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of JGoodies Karsten Lentzsch nor the names of
15: * its contributors may be used to endorse or promote products derived
16: * from this software without specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29: */
30:
31: package com.jgoodies.validation;
32:
33: /**
34: * An enumeration for the severities used in {@link ValidationMessage}.
35: * Useful to categorize validation results, for example to prevent an object
36: * from being saved if the primary key is missing.<p>
37: *
38: * The severity is used in almost all views that present validation messages
39: * and is used in operations on instances of
40: * {@link com.jgoodies.validation.ValidationResult}.
41: *
42: * @author Karsten Lentzsch
43: * @version $Revision: 1.7 $
44: *
45: * @see com.jgoodies.validation.ValidationMessage
46: * @see com.jgoodies.validation.ValidationResult
47: */
48: public enum Severity {
49:
50: /**
51: * Indicates a problem that cannot be resumed or worked around.
52: * For example it prevents an edited value to be saved.
53: */
54: ERROR,
55:
56: /**
57: * Indicates a problem that can be resumed or handled in
58: * a reasonable way. For example a field value may break
59: * a constraint but the object can be temporarily saved.
60: */
61: WARNING,
62:
63: /**
64: * Returned by empty validation results to indicate that
65: * no problem has been detected, or in other words, everything is fine.
66: */
67: OK;
68:
69: /**
70: * Returns the higher of the given severities by comparing their ordinals.
71: * Since the higher severities have a lower ordinal, this method returns
72: * the severity with the lower ordinal.
73: *
74: * @param severity1 the first severity to check
75: * @param severity2 the second severity to check
76: * @return the higher of the given severities
77: */
78: public static Severity max(Severity severity1, Severity severity2) {
79: return severity1.ordinal() < severity2.ordinal() ? severity1
80: : severity2;
81: }
82:
83: }
|