ClientErrorCode (uk.co.visalia.brightpearl:api-client 1.0.0 API)

java.lang.Object
- java.lang.Enum<ClientErrorCode>
- - uk.co.visalia.brightpearl.apiclient.exception.ClientErrorCode

All Implemented Interfaces:

Serializable, Comparable<ClientErrorCode>
```
public enum ClientErrorCode
extends Enum<ClientErrorCode>
```
To aid in troubleshooting problems, these standardised error codes are included in BrightpearlHttpExceptions whenever possible. There are two classes of error included - transport errors, where no response was received from the Brightpearl API, and response errors, where the response from Brightpearl was either corrupt, unexpectedly empty or could not be parsed into an object of the expected type.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CONNECTION_TIMEOUT`
`EMPTY_RESPONSE`
`INVALID_RESPONSE_FORMAT`
`INVALID_RESPONSE_TYPE`
`NO_RESPONSE`
`OTHER_TRANSPORT_ERROR`
`READ_TIMEOUT`
`SOCKET_ERROR`
`SOCKET_TIMEOUT`
`UNKNOWN_HOST`

Method Summary

Methods
Modifier and Type	Method and Description
`static ClientErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ClientErrorCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - EMPTY_RESPONSE
```
public static final ClientErrorCode EMPTY_RESPONSE
```
  - INVALID_RESPONSE_FORMAT
```
public static final ClientErrorCode INVALID_RESPONSE_FORMAT
```
  - INVALID_RESPONSE_TYPE
```
public static final ClientErrorCode INVALID_RESPONSE_TYPE
```
  - NO_RESPONSE
```
public static final ClientErrorCode NO_RESPONSE
```
  - UNKNOWN_HOST
```
public static final ClientErrorCode UNKNOWN_HOST
```
  - CONNECTION_TIMEOUT
```
public static final ClientErrorCode CONNECTION_TIMEOUT
```
  - SOCKET_ERROR
```
public static final ClientErrorCode SOCKET_ERROR
```
  - SOCKET_TIMEOUT
```
public static final ClientErrorCode SOCKET_TIMEOUT
```
  - READ_TIMEOUT
```
public static final ClientErrorCode READ_TIMEOUT
```
  - OTHER_TRANSPORT_ERROR
```
public static final ClientErrorCode OTHER_TRANSPORT_ERROR
```
- Method Detail
  - values
```
public static ClientErrorCode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ClientErrorCode c : ClientErrorCode.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ClientErrorCode valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum ClientErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EMPTY_RESPONSE

INVALID_RESPONSE_FORMAT

INVALID_RESPONSE_TYPE

NO_RESPONSE

UNKNOWN_HOST

CONNECTION_TIMEOUT

SOCKET_ERROR

SOCKET_TIMEOUT

READ_TIMEOUT

OTHER_TRANSPORT_ERROR

Method Detail

values

valueOf