Module com.esri.arcgisruntime

Package com.esri.arcgisruntime

Class ArcGISRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.esri.arcgisruntime.ArcGISRuntimeException

All Implemented Interfaces:

Serializable

public final class ArcGISRuntimeException
extends RuntimeException

An exception that represents an error in the ArcGIS Runtime. More specific information of where the error occurred and what caused it are provided via getErrorDomain() and getErrorCode().

Since:

100.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ArcGISRuntimeException.ErrorDomain	Defines an enumeration of domains of where errors occur.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ERROR_CODE_CHECK_CAUSE	An error code that indicates that further error information are provided in getCause().

Method Summary

Modifier and Type	Method	Description
String	getAdditionalMessage()	Deprecated, for removal: This API element is subject to removal in a future version. since 200.0.0, use getMessage() to access the full error information string
Throwable	getCause()
int	getErrorCode()	Gets an integer error code for this ArcGISRuntimeException.
ArcGISRuntimeException.ErrorDomain	getErrorDomain()	Gets the domain of where the error occurred.
String	getMessage()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, 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

Field Details

ERROR_CODE_CHECK_CAUSE

public static final int ERROR_CODE_CHECK_CAUSE

An error code that indicates that further error information are provided in getCause(). Example:

   Throwable cause = null;
   if (arcGISRuntimeException.getErrorCode() == ArcGISRuntimeException.ERROR_CODE_CHECK_CAUSE) {
     cause = arcGISRuntimeException.getCause();
   }
 

Since:

100.0.0

Method Details

getErrorCode

public int getErrorCode()

Gets an integer error code for this ArcGISRuntimeException. The error code is unique only within this ArcGISRuntimeException's error domain, see getErrorDomain().

Returns:

the error code

Since:

100.0.0

getErrorDomain

public ArcGISRuntimeException.ErrorDomain getErrorDomain()

Gets the domain of where the error occurred.

Returns:

the domain of where the error occurred

Since:

100.0.0

See Also:

• ArcGISRuntimeException.ErrorDomain

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getAdditionalMessage

@Deprecated(since="200.0.0",
            forRemoval=true)
public String getAdditionalMessage()

Deprecated, for removal: This API element is subject to removal in a future version.

since 200.0.0, use getMessage() to access the full error information string

Gets a string with additional information about the error.

Returns:

a string with additional information about the error

Since:

100.0.0

getCause

public Throwable getCause()

Overrides:

getCause in class Throwable