src/main/java/exceptions/VSNegativeNumberException.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

package exceptions;

/**
 * Exception thrown when a negative number is encountered where a positive number is expected.
 * This is typically used for validation of numeric inputs that must be non-negative.
 *
 * @author Paul C. Buetow
 */
public class VSNegativeNumberException extends VSSimulatorException {
    /** The serial version uid */
    private static final long serialVersionUID = 1L;
    
    /**
     * Constructs a new negative number exception.
     */
    public VSNegativeNumberException() {
        super("Negative number not allowed");
    }
    
    /**
     * Constructs a new negative number exception with the specified field name.
     *
     * @param fieldName the name of the field that contained the negative number
     */
    public VSNegativeNumberException(String fieldName) {
        super("Negative number not allowed for field: " + fieldName);
    }
    
    /**
     * Constructs a new negative number exception with the specified field name and value.
     *
     * @param fieldName the name of the field that contained the negative number
     * @param value the negative value that was encountered
     */
    public VSNegativeNumberException(String fieldName, long value) {
        super(String.format("Negative number not allowed for field '%s': %d", fieldName, value));
    }
}