com.box.androidsdk.content.models

Class BoxError

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxError

All Implemented Interfaces:

java.io.Serializable

public class BoxError
extends BoxJsonObject

Class that represents an error from Box.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxError.ErrorContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_CODE
static java.lang.String	FIELD_CONTEXT_INFO
static java.lang.String	FIELD_ERROR
static java.lang.String	FIELD_ERROR_DESCRIPTION
static java.lang.String	FIELD_HELP_URL
static java.lang.String	FIELD_MESSAGE
static java.lang.String	FIELD_REQUEST_ID
static java.lang.String	FIELD_STATUS
static java.lang.String	FIELD_TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxJsonObject

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxError() Constructs an empty BoxError object.
BoxError(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxError with the provided map values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode()
BoxError.ErrorContext	getContextInfo()
java.lang.String	getError()
java.lang.String	getErrorDescription()
java.lang.String	getFieldHelpUrl()
java.lang.String	getMessage()
java.lang.String	getRequestId()
java.lang.Integer	getStatus()
java.lang.String	getType() Gets the type of the error.
protected void	parseJSONMember(com.eclipsesource.json.JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

createFromJson, createFromJson, getPropertiesAsHashMap, parseJsonObject, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_TYPE

public static final java.lang.String FIELD_TYPE

See Also:

Constant Field Values

FIELD_STATUS

public static final java.lang.String FIELD_STATUS

See Also:

Constant Field Values

FIELD_CODE

public static final java.lang.String FIELD_CODE

See Also:

Constant Field Values

FIELD_CONTEXT_INFO

public static final java.lang.String FIELD_CONTEXT_INFO

See Also:

Constant Field Values

FIELD_HELP_URL

public static final java.lang.String FIELD_HELP_URL

See Also:

Constant Field Values

FIELD_MESSAGE

public static final java.lang.String FIELD_MESSAGE

See Also:

Constant Field Values

FIELD_REQUEST_ID

public static final java.lang.String FIELD_REQUEST_ID

See Also:

Constant Field Values

FIELD_ERROR

public static final java.lang.String FIELD_ERROR

See Also:

Constant Field Values

FIELD_ERROR_DESCRIPTION

public static final java.lang.String FIELD_ERROR_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

BoxError

public BoxError()

Constructs an empty BoxError object.

BoxError

public BoxError(java.util.Map<java.lang.String,java.lang.Object> map)

Constructs a BoxError with the provided map values.

Parameters:

map - map of keys and values of the object.

Method Detail

getType

public java.lang.String getType()

Gets the type of the error.

Returns:

the error type.

getStatus

public java.lang.Integer getStatus()

Returns:

status code of the error.

getCode

public java.lang.String getCode()

Returns:

the code of the error.

getContextInfo

public BoxError.ErrorContext getContextInfo()

getFieldHelpUrl

public java.lang.String getFieldHelpUrl()

Returns:

a url to get more information about the error.

getMessage

public java.lang.String getMessage()

Returns:

get a human readable string describing the error.

getRequestId

public java.lang.String getRequestId()

Returns:

the id of the error.

getError

public java.lang.String getError()

Returns:

the error code.

getErrorDescription

public java.lang.String getErrorDescription()

Returns:

the error description.

parseJSONMember

protected void parseJSONMember(com.eclipsesource.json.JsonObject.Member member)

Description copied from class: BoxJsonObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Overrides:

parseJSONMember in class BoxJsonObject

Parameters:

member - the JSON member to be parsed.