/*
 * Copyright [2013-2014] PayPal Software Foundation
 *  
 * 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 ml.shifu.guagua;

import java.io.IOException;

/**
 * {@link GuaguaException} is checked exception in guagua framework.
 */
public class GuaguaException extends IOException {
    
    private static final long serialVersionUID = -5455718714680634758L;

    /**
     * Constructs an {@code GuaguaException} with {@code null} as its error detail message.
     */
    public GuaguaException() {
    }

    /**
     * Constructs an {@code GuaguaException} with the specified detail message.
     * 
     * @param message
     *            The detail message (which is saved for later retrieval by the {@link #getMessage()} method)
     */
    public GuaguaException(String message) {
        super(message);
    }

    /**
     * Constructs an {@code GuaguaException} with the specified detail message and cause.
     * 
     * <p>
     * Note that the detail message associated with {@code cause} is <i>not</i> automatically incorporated into this
     * exception's detail message.
     * 
     * @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). (A null value is
     *            permitted, and indicates that the cause is nonexistent or unknown.)
     */
    public GuaguaException(String message, Throwable cause) {
        super(message, cause);
    }

    /**
     * Constructs an {@code GuaguaException} with the specified cause and a detail message of
     * {@code (cause==null ? null : cause.toString())} (which typically contains the class and detail message of
     * {@code cause}).
     * This constructor is useful for IO exceptions that are little more than wrappers for other throwables.
     * 
     * @param cause
     *            The cause (which is saved for later retrieval by the {@link #getCause()} method). (A null value is
     *            permitted, and indicates that the cause is nonexistent or unknown.)
     */
    public GuaguaException(Throwable cause) {
        super(cause);
    }

}