com.wowza.gocoder.sdk.api.errors

Class WOWZError

java.lang.Object

com.wowza.gocoder.sdk.api.errors.WOWZError

Direct Known Subclasses:

WOWZPlatformError, WOWZSDKError, WOWZStreamingError

public class WOWZError
extends java.lang.Object

The base class for errors reported by the GoCoder SDK API classes.

Constructor Summary

Constructors

Constructor and Description
WOWZError(java.lang.Exception exception) Constructs an error by an exception.
WOWZError(java.lang.String errorDescription) Creates and initializes an instance using the specified property values.
WOWZError(java.lang.String errorDescription, boolean warning) Constructs an error by providing the description and a warning indicator.
WOWZError(java.lang.String errorDescription, java.lang.Exception exception) Constructs an error by providing the description and an exception.
WOWZError(java.lang.String errorClass, int errorCode) Constructs an error by providing the error class and code.
WOWZError(java.lang.String errorClass, int errorCode, boolean warning) Constructs an error by providing the error class and code and a warning indicator.
WOWZError(java.lang.String errorClass, int errorCode, java.lang.Exception exception) Constructs an error by providing the error class and code and an exception.
WOWZError(java.lang.String errorClass, int errorCode, java.lang.Exception exception, boolean warning) Constructs an error by providing the error class, code, an exception, and a warning indicator.
WOWZError(WOWZError other) Creates and initializes an instance using the property values from the specified instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorClass() Gets an identifier for the error class that is unique among all components of the SDK.
int	getErrorCode() Gets an identifier for the error that is unique within the corresponding error class.
java.lang.String	getErrorDescription() Gets a detailed description of the error.
java.lang.Exception	getException() Gets the exception associated with this error, if any.
boolean	isWarning() Indicates whether the error can be considered a warning.
static void	registerErrors(java.lang.String errorClass)
void	set(WOWZError other) Updates the property values of this instance with the property values from the specified instance.
void	setErrorDescription(java.lang.String errorDescription) Provides a custom error message.
java.lang.String	toString() Gets a human-readable description of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

WOWZError

public WOWZError(java.lang.String errorClass,
                 int errorCode,
                 java.lang.Exception exception,
                 boolean warning)

Constructs an error by providing the error class, code, an exception, and a warning indicator.

Parameters:

errorClass - An identifier for the error class that is unique among all components of the SDK.

errorCode - An identifier for the error that is unique within the corresponding error class.

exception - An exception to associate with this error.

warning - Indicates whether the error can be considered a warning.

WOWZError

public WOWZError(java.lang.String errorClass,
                 int errorCode,
                 boolean warning)

Constructs an error by providing the error class and code and a warning indicator.

Parameters:

errorClass - An identifier for the error class that is unique among all components of the SDK.

errorCode - An identifier for the error that is unique within the corresponding error class.

warning - Indicates whether the error can be considered a warning.

WOWZError

public WOWZError(java.lang.String errorClass,
                 int errorCode)

Constructs an error by providing the error class and code.

Parameters:

errorClass - An identifier for the error class that is unique among all components of the SDK.

errorCode - An identifier for the error that is unique within the corresponding error class.

WOWZError

public WOWZError(java.lang.String errorClass,
                 int errorCode,
                 java.lang.Exception exception)

Constructs an error by providing the error class and code and an exception.

Parameters:

errorClass - An identifier for the error class that is unique among all components of the SDK.

errorCode - An identifier for the error that is unique within the corresponding error class.

exception - An exception to associate with this error.

WOWZError

public WOWZError(java.lang.String errorDescription,
                 boolean warning)

Constructs an error by providing the description and a warning indicator.

Parameters:

errorDescription - The error message.

warning - Indicates if the error can be considered a warning.

WOWZError

public WOWZError(java.lang.String errorDescription,
                 java.lang.Exception exception)

Constructs an error by providing the description and an exception.

Parameters:

errorDescription - The error message.

exception - An exception to associate with this error.

WOWZError

public WOWZError(java.lang.Exception exception)

Constructs an error by an exception.

Parameters:

exception - An exception to associate with this error.

WOWZError

public WOWZError(java.lang.String errorDescription)

Creates and initializes an instance using the specified property values.

Parameters:

errorDescription - The error message.

WOWZError

public WOWZError(WOWZError other)

Creates and initializes an instance using the property values from the specified instance.

Parameters:

other - The instance to use.

Method Detail

set

public void set(WOWZError other)

Updates the property values of this instance with the property values from the specified instance.

Parameters:

other - The instance with the property values to use.

setErrorDescription

public void setErrorDescription(java.lang.String errorDescription)

Provides a custom error message.

Parameters:

errorDescription - An error description to override any normally loaded from resources for the associated error code.

toString

public java.lang.String toString()

Gets a human-readable description of this instance.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this instance.

isWarning

public boolean isWarning()

Indicates whether the error can be considered a warning.

Returns:

True if the error can be considered a warning; false otherwise.

getErrorClass

public java.lang.String getErrorClass()

Gets an identifier for the error class that is unique among all components of the SDK.

Returns:

The error class.

getErrorCode

public int getErrorCode()

Gets an identifier for the error that is unique within the corresponding error class.

Returns:

The error code.

getErrorDescription

public java.lang.String getErrorDescription()

Gets a detailed description of the error.

Returns:

The error description.

getException

public java.lang.Exception getException()

Gets the exception associated with this error, if any.

Returns:

The exception associated with this error, or null if an exception was not specified at creation time.

registerErrors

public static void registerErrors(java.lang.String errorClass)