com.pb.routing.exceptions

Class RoutingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.pb.routing.exceptions.RoutingException

All Implemented Interfaces:

Serializable

public class RoutingException
extends Exception

This class is used for Routing-specific error messages. It behaves as an Exception but adds an integer return code to pass back error codes to the routing engine.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RoutingException(int code, Object[] args) Creates the exception with an error code and parameters.
RoutingException(int code, Object[] args, Throwable rootException) Creates the exception with an error code, parameters and a Throwable root cause.
RoutingException(RoutingException re)
RoutingException(String msg) Constructs the exception with an error message.
RoutingException(String msg, int code) Constructs the exception with an error message and an error code.

Method Summary

Modifier and Type	Method and Description
Object[]	getArgs() Gets the arguments associated with this exception.
int	getCode() Gets the error code associated with this error.
String	getMessage() Gets the message string of this throwable.
String	getMessage(Locale locale) Gets a localized error message.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RoutingException

public RoutingException(String msg)

Constructs the exception with an error message. This should only be used on the client throwing an exception generated on the server.

Parameters:

msg - The error message generated by the server.

RoutingException

public RoutingException(String msg,
                        int code)

Constructs the exception with an error message and an error code. This should only be used on the client throwing an exception generated on the server.

Parameters:

msg - The error message generated by the server.

code - The error code generated by the server.

RoutingException

public RoutingException(int code,
                        Object[] args)

Creates the exception with an error code and parameters.

Parameters:

code - The error code generated by the server.

args - The argument that needs to be passed along with this exception.

RoutingException

public RoutingException(int code,
                        Object[] args,
                        Throwable rootException)

Creates the exception with an error code, parameters and a Throwable root cause.

Parameters:

code - The error code generated by the server.

args - The argument that needs to be passed along with this exception.

rootException - The original exception being thrown from the server.

RoutingException

public RoutingException(RoutingException re)

Method Detail

getCode

public int getCode()

Gets the error code associated with this error.

Returns:

An int value for error code.

getArgs

public Object[] getArgs()

Gets the arguments associated with this exception.

getMessage

public String getMessage(Locale locale)

Gets a localized error message.

Parameters:

locale - The desired locale to use.

getMessage

public String getMessage()

Gets the message string of this throwable.

Overrides:

getMessage in class Throwable

Returns:

Message string of this Throwable instance (which may be null).