io.guise.framework.validator.ValidationException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
There is a newer version: 0.5.3
/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.guise.framework.validator;

import io.guise.framework.Resources;

/**
 * Exception class for a validation error. The stored message may be a resource reference, which will be resolved at a later time when needed.
 * @author Garret Wilson
 * @see Resources#createStringResourceReference(String)
 */
public class ValidationException extends Exception {

	/** The value being validated, which may be of any type, or null if the value being validated is not available. */
	private final Object value;

	/** @return The value being validated, which may be of any type, or null if the value being validated is not available. */
	public Object getValue() {
		return value;
	}

	/**
	 * Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to
	 * {@link Throwable#initCause(java.lang.Throwable)}.
	 */
	public ValidationException() {
		this((String)null); //construct the class with no message
	}

	/**
	 * Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to
	 * {@link Throwable#initCause(java.lang.Throwable)}.
	 * @param message The detail message. The detail message is saved for later retrieval by the {@link #getMessage()} method.
	 */
	public ValidationException(final String message) {
		this(message, null); //construct the class with the message and no value
	}

	/**
	 * Constructs a new exception with the specified detail message and value object. The cause is not initialized, and may subsequently be initialized by a call
	 * to {@link Throwable#initCause(java.lang.Throwable)}.
	 * @param message The detail message. The detail message is saved for later retrieval by the {@link #getMessage()} method.
	 * @param value The value being validated, which may be of any type, or null if the value being validated is not available.
	 */
	public ValidationException(final String message, final Object value) {
		this(message, null, value); //construct the class with no cause
	}

	/**
	 * Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()).
	 * @param cause The cause (which is saved for later retrieval by the {@link #getCause()} method), or null if the cause is nonexistent or unknown.
	 */
	public ValidationException(final Throwable cause) {
		this(cause != null ? cause.toString() : null, cause); //construct the class with a cause message, if possible
	}

	/**
	 * Constructs a new exception with the specified detail message and cause.
	 * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
	 * @param cause The cause (which is saved for later retrieval by the {@link #getCause()} method), or null if the cause is nonexistent or unknown.
	 */
	public ValidationException(final String message, final Throwable cause) {
		this(message, cause, null); //construct the class, indicating that no value is available
	}

	/**
	 * Constructs a new exception with the specified detail message, cause, and value object.
	 * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
	 * @param cause The cause (which is saved for later retrieval by the {@link #getCause()} method), or null if the cause is nonexistent or unknown.
	 * @param value The value being validated, which may be of any type, or null if the value being validated is not available.
	 */
	public ValidationException(final String message, final Throwable cause, final Object value) {
		super(message, cause); //construct the parent class with the message and cause
		this.value = value; //save the value
	}

}