com.squareup.square.models

Class Error

java.lang.Object

com.squareup.square.models.Error

public class Error
extends Object

This is a model class for Error type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Error.Builder Class to build instances of Error.

Constructor Summary

Constructors

Constructor and Description
Error(String category, String code, String detail, String field) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCategory() Getter for Category.
String	getCode() Getter for Code.
String	getDetail() Getter for Detail.
String	getField() Getter for Field.
int	hashCode()
Error.Builder	toBuilder() Builds a new Error.Builder object.
String	toString() Converts this Error into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Error

public Error(String category,
             String code,
             String detail,
             String field)

Initialization constructor.

Parameters:

category - String value for category.

code - String value for code.

detail - String value for detail.

field - String value for field.

Method Detail

getCategory

public String getCategory()

Getter for Category. Indicates which high-level category of error has occurred during a request to the Connect API.

Returns:

Returns the String

getCode

public String getCode()

Getter for Code. Indicates the specific error that occurred during a request to a Square API.

Returns:

Returns the String

getDetail

public String getDetail()

Getter for Detail. A human-readable description of the error for debugging purposes.

Returns:

Returns the String

getField

public String getField()

Getter for Field. The name of the field provided in the original request (if any) that the error pertains to.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this Error into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Error.Builder toBuilder()

Builds a new Error.Builder object. Creates the instance with the state of the current model.

Returns:

a new Error.Builder object