org.opendaylight.vtn.manager.VTNException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of manager Show documentation
VTN Manager's API bundle.
There is a newer version: 0.8.0
/*
 * Copyright (c) 2013, 2015 NEC Corporation. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.vtn.manager;

import org.opendaylight.yang.gen.v1.urn.opendaylight.vtn.types.rev150209.VtnErrorTag;

/**
 * {@code VTNException} is an exception for notifying errors caused by the
 *  VTN Manager.
 */
public class VTNException extends Exception {
    /**
     * Version number for serialization.
     */
    private static final long  serialVersionUID = -6030375836343768899L;

    /**
     * The {@link VtnErrorTag} object which indicates the result of the
     * operation.
     */
    private final VtnErrorTag  errorTag;

    /**
     * Consturct a new {@code VTNException} instance that internally stores
     * the given message and {@link VtnErrorTag}.
     *
     * @param etag  The error tag which indicates the cause of error.
     * @param msg   The detailed message.
     */
    public VTNException(VtnErrorTag etag, String msg) {
        super(msg);
        errorTag = etag;
    }

    /**
     * Consturct a new {@code VTNException} instance that internally stores
     * the given message {@link VtnErrorTag}.
     *
     * @param etag   The error tag which indicates the cause of error.
     * @param msg    The detailed message.
     * @param cause  The {@link Throwable} object which indicates the cause
     *               of error.
     */
    public VTNException(VtnErrorTag etag, String msg, Throwable cause) {
        super(msg, cause);
        errorTag = etag;
    }

    /**
     * Consturct a new {@code VTNException} that indicates an internal error.
     *
     * 
     *   
     *     A new exception internally stores {@link VtnErrorTag#INTERNALERROR}.
     *   
     * 
     *
     * @param msg  The detailed message.
     * @since  Lithium
     */
    public VTNException(String msg) {
        this(null, msg);
    }

    /**
     * Consturct a new {@code VTNException} that indicates an internal error.
     *
     * 
     *   
     *     A new exception internally stores {@link VtnErrorTag#INTERNALERROR}.
     *   
     * 
     *
     * @param msg    The detailed message.
     * @param cause  The {@link Throwable} object which indicates the cause
     *               of error.
     */
    public VTNException(String msg, Throwable cause) {
        this(null, msg, cause);
    }

    /**
     * Return the {@link VtnErrorTag} instance which indicates the result of
     * the operation.
     *
     * @return  A {@link VtnErrorTag} instance.
     */
    public final VtnErrorTag getVtnErrorTag() {
        return (errorTag == null) ? VtnErrorTag.INTERNALERROR : errorTag;
    }
}