com.wowza.gocoder.sdk.api.errors

Class WZError

java.lang.Object

com.wowza.gocoder.sdk.api.errors.WZError

Direct Known Subclasses:

WZPlatformError, WZSDKError, WZStreamingError

public class WZError
extends Object

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

Constructor Summary

Constructors

Constructor and Description
WZError(Exception exception) Construct an error by an exception
WZError(String errorDescription) Construct a new instance using the specified property values
WZError(String errorDescription, boolean warning) Construct an error by providing the description and a warning indicator
WZError(String errorDescription, Exception exception) Construct an error by providing the description and an exception
WZError(String errorClass, int errorCode) Construct an error by providing the error class and code
WZError(String errorClass, int errorCode, boolean warning) Construct an error by providing the error class and code and a warning indicator
WZError(String errorClass, int errorCode, Exception exception) Construct an error by providing the error class and code and an exception
WZError(String errorClass, int errorCode, Exception exception, boolean warning) Construct an error by providing the error class, code, an exception, and a warning indicator
WZError(WZError other) Construct a new instance using the property values from the specified instance

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

WZError

public WZError(String errorClass,
               int errorCode,
               Exception exception,
               boolean warning)

Construct 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 if the error can be considered just a warning

WZError

public WZError(String errorClass,
               int errorCode,
               boolean warning)

Construct 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 if the error can be considered just a warning

WZError

public WZError(String errorClass,
               int errorCode)

Construct 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

WZError

public WZError(String errorClass,
               int errorCode,
               Exception exception)

Construct 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

WZError

public WZError(String errorDescription,
               boolean warning)

Construct an error by providing the description and a warning indicator

Parameters:

errorDescription - The error message

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

WZError

public WZError(String errorDescription,
               Exception exception)

Construct an error by providing the description and an exception

Parameters:

errorDescription - The error message

exception - An exception to associate with this error

WZError

public WZError(Exception exception)

Construct an error by an exception

Parameters:

exception - An exception to associate with this error

WZError

public WZError(String errorDescription)

Construct a new instance using the specified property values

Parameters:

errorDescription - The error message

WZError

public WZError(WZError other)

Construct a new instance using the property values from the specified instance

Parameters:

other - The instance to replicate

Method Detail

set

public void set(WZError other)

Update the property values of this instance with the property values from the specified instance

Parameters:

other - The instance with the property values to replicate

setErrorDescription

public void setErrorDescription(String errorDescription)

Provide a custom error message

Parameters:

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

toString

public String toString()

Returns a human-readable description of this instance

Overrides:

toString in class Object

Returns:

A string representation of this instance

isWarning

public boolean isWarning()

Indicates if the error can be considered just a warning

Returns:

true if the error can be considered just a warning, false otherwise

getErrorClass

public String getErrorClass()

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

Returns:

the error class

getErrorCode

public int getErrorCode()

Returns an identifier for the error that is unique within the corresponding error class

Returns:

the error code

getErrorDescription

public String getErrorDescription()

Returns a detailed description of the error

Returns:

the error description

getException

public Exception getException()

Returns 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(String errorClass)