com.google.api.gbase.client

Class ServiceErrors

java.lang.Object

com.google.api.gbase.client.ServiceErrors

public class ServiceErrors
extends Object

Extracts and organizes error messages from a ServiceException or from a BatchStatus. This object parses the body of a ServiceException or the content of a BatchStatus and gives programmatic access to the error messages embedded in the body of the exception.

Constructor Summary

Constructors

Constructor and Description
ServiceErrors() Empty constructor.
ServiceErrors(BatchStatus status) Creates a ServiceErrors object corresponding to the errors contained in BatchStatus.
ServiceErrors(ServiceException e) Creates a ServiceErrors object corresponding to the errors contained in a ServiceException.

Method Summary

Methods

Modifier and Type	Method and Description
void	addError(ServiceError error) Registers a new error.
void	addErrors(BatchStatus status) Extracts errors from a BatchStatus.
void	addErrors(ServiceException e) Extracts errors from a ServiceException.
List<? extends ServiceError>	getAllErrors() Gets all errors.
Collection<? extends ServiceError>	getDataErrors() Gets data errors, which apply to the item content, often to one field in particular.
Set<? extends String>	getErrorFields() Gets the set of all fields that have errors.
List<? extends ServiceError>	getFieldErrors(String field) Gets all errors for one specific field.
List<? extends ServiceError>	getRequestErrors() Gets non-data errors, which apply to the whole request.
String	toString() Returns a convenient text representation, for debugging.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceErrors

public ServiceErrors(ServiceException e)

Creates a ServiceErrors object corresponding to the errors contained in a ServiceException.

Parameters:

e -

ServiceErrors

public ServiceErrors(BatchStatus status)

Creates a ServiceErrors object corresponding to the errors contained in BatchStatus.

Parameters:

status -

ServiceErrors

public ServiceErrors()

Empty constructor.

Method Detail

toString

public String toString()

Returns a convenient text representation, for debugging.

Overrides:

toString in class Object

addErrors

public void addErrors(ServiceException e)

Extracts errors from a ServiceException.

Parameters:

e - the ServiceException to be parsed

addErrors

public void addErrors(BatchStatus status)

Extracts errors from a BatchStatus.

Parameters:

status - the BatchStatus to be parsed

addError

public void addError(ServiceError error)

Registers a new error.

Parameters:

error -

getAllErrors

public List<? extends ServiceError> getAllErrors()

Gets all errors.

Returns:

both request and data errors. May be empty but not null.

getRequestErrors

public List<? extends ServiceError> getRequestErrors()

Gets non-data errors, which apply to the whole request.

Returns:

non-data errors. May be empty but not null.

getDataErrors

public Collection<? extends ServiceError> getDataErrors()

Gets data errors, which apply to the item content, often to one field in particular.

Returns:

data errors. May be empty but not null.

getErrorFields

public Set<? extends String> getErrorFields()

Gets the set of all fields that have errors.

Returns:

field names. May be empty but not null.

getFieldErrors

public List<? extends ServiceError> getFieldErrors(String field)

Gets all errors for one specific field.

Parameters:

field - field name, which usually comes from getErrorFields()

Returns:

all errors applied to the field. May be empty but not null.