ServerServiceException.java

// BlogBridge -- RSS feed reader, manager, and web based service
// Copyright (C) 2002-2006 by R. Pito Salas
//
// This program is free software; you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free Software Foundation;
// either version 2 of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program;
// if not, write to the Free Software Foundation, Inc., 59 Temple Place,
// Suite 330, Boston, MA 02111-1307 USA
//
// Contact: R. Pito Salas
// mailto:pitosalas@users.sourceforge.net
// More information: about BlogBridge
// http://www.blogbridge.com
// http://sourceforge.net/projects/blogbridge
//
// $Id: ServerServiceException.java,v 1.6 2006/01/08 04:57:14 kyank Exp $
//

package com.salas.bb.service;

/**
 * Basic exception which can be thrown from <code>ServerService</code> class.
 */
public class ServerServiceException extends Exception
{
    // ---------------------------------------------------------------------------------------------
    // Exception types
    // ---------------------------------------------------------------------------------------------

    /** Other errors. */
    public static final int TYPE_OTHER = 0;

    /** Account is already registered in the service. */
    public static final int TYPE_ACCOUNT_IS_ALREADY_REGISTERED = 1;

    // Error type
    private int type;

    /**
     * Constructs exception object.
     *
     * @param message descriptive message.
     */
    public ServerServiceException(String message)
    {
        this(TYPE_OTHER, message, null);
    }

    /**
     * Constructs exception object.
     *
     * @param aType   type of exception.
     * @param message descriptive message.
     *
     * @see #TYPE_OTHER
     * @see #TYPE_ACCOUNT_IS_ALREADY_REGISTERED
     */
    public ServerServiceException(int aType, String message)
    {
        this(aType, message, null);
    }

    /**
     * Constructs exception object with underlying exception.
     *
     * @param message descriptive message.
     * @param cause   underlying cause.
     */
    public ServerServiceException(String message, Throwable cause)
    {
        this(TYPE_OTHER, message, cause);
    }

    /**
     * Constructs exception object with underlying exception.
     *
     * @param aType   type of exception.
     * @param message descriptive message.
     * @param cause   underlying cause.
     *
     * @see #TYPE_OTHER
     * @see #TYPE_ACCOUNT_IS_ALREADY_REGISTERED
     */
    public ServerServiceException(int aType, String message, Throwable cause)
    {
        super(message, cause);
        type = aType;
    }

    /**
     * Returns type of exception.
     *
     * @return type.
     *
     * @see #TYPE_OTHER
     * @see #TYPE_ACCOUNT_IS_ALREADY_REGISTERED
     */
    public int getType()
    {
        return type;
    }
}