com.jrfom.gw2.api.model

Class GwApiError

java.lang.Object

java.lang.Throwable

java.lang.Error

com.jrfom.gw2.api.model.GwApiError

All Implemented Interfaces:

Serializable

@Gw2ApiVersion(value="v1")
public class GwApiError
extends Error

Represents the error object returned from the Guild Wars 2 API when an invalid parameter is passed to a method. This error will be thrown whenever such a response is received from the remote service. You can either ignore it, or use a try...catch to trap it.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GwApiError()

Method Summary

Methods

Modifier and Type	Method and Description
int	getError() Retrieve the error number associated with the instance.
int	getLine() Retrieve the line number in ArenaNet's remote code that generated this error.
String	getMessage()
int	getModule() Retrieve the module identifier associated with the instance.
int	getProduct() Retrieve the product identifier associated with the instance.
String	getText() Retrieve a text description of the error.
void	setError(int error)
void	setLine(int line)
void	setModule(int module)
void	setProduct(int product)
void	setText(String text)

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

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

Constructor Detail

GwApiError

public GwApiError()

Method Detail

getError

public int getError()

Retrieve the error number associated with the instance.

Returns:

A generic error number.

setError

public void setError(int error)

getProduct

public int getProduct()

Retrieve the product identifier associated with the instance.

Returns:

Some product id used by ArenaNet.

setProduct

public void setProduct(int product)

getModule

public int getModule()

Retrieve the module identifier associated with the instance.

Returns:

Some module id used by ArenaNet.

setModule

public void setModule(int module)

getLine

public int getLine()

Retrieve the line number in ArenaNet's remote code that generated this error.

Returns:

The ArenaNet code's line number.

setLine

public void setLine(int line)

getText

public String getText()

Retrieve a text description of the error.

Returns:

The error description as returned by ArenaNet.

setText

public void setText(String text)

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable