/*
 * Copyright (c) 2008-2011, Piccolo2D project, http://piccolo2d.org
 * Copyright (c) 1998-2008, University of Maryland
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided
 * that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this list of conditions
 * and the following disclaimer.
 *
 * 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.
 *
 * None of the name of the University of Maryland, the name of the Piccolo2D project, or 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 edu.umd.cs.piccolo.util;

/**
 * This class is used to encapsulate exceptions that may occur while performing transform operations.
 *
 * @since 1.3
 */
public class PAffineTransformException extends RuntimeException {
    /**
     * Allows for future serialization code to understand versioned binary
     * formats.
     */
    private static final long serialVersionUID = 1L;

    private final PAffineTransform errantTransform;

    /**
     * Constructs an Exception that represents an error with the
     * errantTransform.
     * 
     * @param errantTransform transform that caused the error
     */
    public PAffineTransformException(final PAffineTransform errantTransform) {
        this.errantTransform = errantTransform;
    }

    /**
     * Constructs an Exception that represents an error with the
     * errantTransform.
     * 
     * @param message Text message provided by the programmer about the context
     *            of the error
     * @param errantTransform transform that caused the error
     */
    public PAffineTransformException(final String message, final PAffineTransform errantTransform) {
        super(message);
        this.errantTransform = errantTransform;
    }

    /**
     * Constructs an Exception that wraps another and records the errant
     * transform.
     * 
     * @param throwable the root cause of the exception
     * @param errantTransform transform that's related to the error
     */
    public PAffineTransformException(final Throwable throwable, final PAffineTransform errantTransform) {
        super(throwable);
        this.errantTransform = errantTransform;
    }

    /**
     * Constructs an Exception that wraps another and records the errant
     * transform and provides a human readable message about the exception's
     * context.
     * 
     * @param message Text message provided by the programmer about the context
     *            of the error
     * @param throwable the root cause of the exception
     * @param errantTransform transform that's related to the error
     */
    public PAffineTransformException(final String message, final Throwable throwable,
            final PAffineTransform errantTransform) {
        super(message, throwable);
        this.errantTransform = errantTransform;
    }

    /**
     * Used to access the transform related to this exception.
     * 
     * @return transform related to the exception
     */
    public PAffineTransform getErrantTransform() {
        return errantTransform;
    }

}
