com.yahoo.bullet.pubsub

Class PubSubException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.yahoo.bullet.pubsub.PubSubException

All Implemented Interfaces:

Serializable

public class PubSubException
extends Exception

Exception to be thrown if there is an error in PubSub, Publisher or Subscriber.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PubSubException(String message) Constructor to initialize PubSubException with a message.
PubSubException(String message, Throwable cause) Constructor to initialize PubSubException with a message and a Throwable cause.

Method Summary

Modifier and Type	Method and Description
static PubSubException	forArgument(String name, Throwable cause) Method to create a PubSubException when a required argument could not be read.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PubSubException

public PubSubException(String message)

Constructor to initialize PubSubException with a message.

Parameters:

message - The error message to be associated with the PubSubException.

PubSubException

public PubSubException(String message,
                       Throwable cause)

Constructor to initialize PubSubException with a message and a Throwable cause.

Parameters:

message - The error message to be associated with the PubSubException.

cause - The reason for the PubSubException.

Method Detail

forArgument

public static PubSubException forArgument(String name,
                                          Throwable cause)

Method to create a PubSubException when a required argument could not be read.

Parameters:

name - The name of the argument that could not be read.

cause - The optional Throwable that caused the exception.

Returns:

A PubSubException indicating failure to read a required argument.