com.atlassian.marketplace.client.model

Class ErrorDetail

java.lang.Object

com.atlassian.marketplace.client.model.ErrorDetail

public class ErrorDetail
extends Object

Details of an error returned by the server.

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
ErrorDetail()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
com.atlassian.fugue.Option<String>	getCode() The error code.
String	getMessage() The error message.
com.atlassian.fugue.Option<String>	getPath() The path to a request property that was involved in the error, if any.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorDetail

public ErrorDetail()

Method Detail

getMessage

public String getMessage()

The error message. For errors related to a specific request property, the message will normally be a fragment such as "required" or "cannot be zero" rather than a complete sentence; refer to getPath() to see which property was involved.

getCode

public com.atlassian.fugue.Option<String> getCode()

The error code. If present, this string is a stable identifier for some specific type of error, which will not change even if the message text changes.

getPath

public com.atlassian.fugue.Option<String> getPath()

The path to a request property that was involved in the error, if any. This uses JSON Pointer format, and refers to the JSON representation of the request: so, for instance, a top-level property called "name" would have a path of "/name", and the link URI of a "vendor" link would have a path of "/_links/vendor/href".

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object