com.atlassian.jira.util

Class SimpleErrorCollection

java.lang.Object

com.atlassian.jira.util.SimpleErrorCollection

All Implemented Interfaces:

ErrorCollection, Serializable

@PublicApi
public class SimpleErrorCollection
extends Object
implements ErrorCollection

The most straightforward serializable implementation of ErrorCollection interface.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Constructor Summary

Constructors

Constructor and Description
SimpleErrorCollection()
SimpleErrorCollection(ErrorCollection errorCollection)
SimpleErrorCollection(List<String> errorMessages, Set<ErrorCollection.Reason> reasons)
SimpleErrorCollection(String errorMessage)
SimpleErrorCollection(String errorMsg, ErrorCollection.Reason reason)

Method Summary

Modifier and Type	Method and Description
void	addError(String field, String message) Add a field-specific error message.
void	addError(String field, String message, ErrorCollection.Reason reason) Add a field-specific error message.
void	addErrorCollection(ErrorCollection errors) Populate this ErrorCollection with general and field-specific errors.
void	addErrorMessage(String message) Add error message relating to system state (not field-specific).
void	addErrorMessage(String message, ErrorCollection.Reason reason) Add error message relating to system state (not field-specific), and a reason.
void	addErrorMessages(Collection<String> incomingMessages) Append new error messages to those already collected.
void	addErrors(Map<String,String> incomingErrors) Append new field-specific errors to those already collected.
void	addReason(ErrorCollection.Reason reason) Add a reason why the function has not been performed.
void	addReasons(Set<ErrorCollection.Reason> reasons) Add reasons why the function has not been performed.
boolean	equals(Object o)
Collection<String>	getErrorMessages() Get all non field-specific error messages.
Map<String,String>	getErrors() Get all field-specific errors.
Collection<String>	getFlushedErrorMessages() Get error messages, then get rid of them.
Set<ErrorCollection.Reason>	getReasons() A set of well known reasons why the function has not been performed.
boolean	hasAnyErrors() Whether any errors (of any type - field-specific or otherwise) have been collected.
int	hashCode()
void	setErrorMessages(Collection<String> errorMessages) Populate this ErrorCollection with a new set of messages (existing errors are lost).
void	setReasons(Set<ErrorCollection.Reason> reasons) Set reasons why the function has not been performed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleErrorCollection

public SimpleErrorCollection()

SimpleErrorCollection

public SimpleErrorCollection(String errorMessage)

SimpleErrorCollection

public SimpleErrorCollection(String errorMsg,
                             ErrorCollection.Reason reason)

SimpleErrorCollection

public SimpleErrorCollection(List<String> errorMessages,
                             Set<ErrorCollection.Reason> reasons)

SimpleErrorCollection

public SimpleErrorCollection(ErrorCollection errorCollection)

Method Detail

addError

public void addError(String field,
                     String message)

Description copied from interface: ErrorCollection

Add a field-specific error message.

Specified by:

addError in interface ErrorCollection

Parameters:

field - Field name, eg. "assignee"

message - Error message.

addErrorMessage

public void addErrorMessage(String message)

Description copied from interface: ErrorCollection

Add error message relating to system state (not field-specific).

Specified by:

addErrorMessage in interface ErrorCollection

Parameters:

message - Error message.

getErrorMessages

public Collection<String> getErrorMessages()

Description copied from interface: ErrorCollection

Get all non field-specific error messages.

Specified by:

getErrorMessages in interface ErrorCollection

Returns:

Collection of error Strings.

setErrorMessages

public void setErrorMessages(Collection<String> errorMessages)

Description copied from interface: ErrorCollection

Populate this ErrorCollection with a new set of messages (existing errors are lost).

Specified by:

setErrorMessages in interface ErrorCollection

Parameters:

errorMessages - List of error message Strings.

getFlushedErrorMessages

public Collection<String> getFlushedErrorMessages()

Description copied from interface: ErrorCollection

Get error messages, then get rid of them.

Specified by:

getFlushedErrorMessages in interface ErrorCollection

Returns:

The (now cleared) error messages.

getErrors

public Map<String,String> getErrors()

Description copied from interface: ErrorCollection

Get all field-specific errors.

Specified by:

getErrors in interface ErrorCollection

Returns:

Map of String: String pairs, eg. {"assignee": "Assignee is required"}

addErrorCollection

public void addErrorCollection(ErrorCollection errors)

Description copied from interface: ErrorCollection

Populate this ErrorCollection with general and field-specific errors.

Specified by:

addErrorCollection in interface ErrorCollection

Parameters:

errors - ErrorCollection whose errors/messages we obtain.

addErrorMessages

public void addErrorMessages(Collection<String> incomingMessages)

Description copied from interface: ErrorCollection

Append new error messages to those already collected.

Specified by:

addErrorMessages in interface ErrorCollection

Parameters:

incomingMessages - Collection of error strings.

addErrors

public void addErrors(Map<String,String> incomingErrors)

Description copied from interface: ErrorCollection

Append new field-specific errors to those already collected.

Specified by:

addErrors in interface ErrorCollection

Parameters:

incomingErrors - of String: String pairs, eg. {"assignee": "Assignee is required"}

hasAnyErrors

public boolean hasAnyErrors()

Description copied from interface: ErrorCollection

Whether any errors (of any type - field-specific or otherwise) have been collected.

Specified by:

hasAnyErrors in interface ErrorCollection

Returns:

true if any errors (of any type - field-specific or otherwise) have been collected.

addError

public void addError(String field,
                     String message,
                     ErrorCollection.Reason reason)

Description copied from interface: ErrorCollection

Add a field-specific error message.

Specified by:

addError in interface ErrorCollection

Parameters:

field - Field name, eg. "assignee"

message - Error message.

reason - Reason for the error.

addErrorMessage

public void addErrorMessage(String message,
                            ErrorCollection.Reason reason)

Description copied from interface: ErrorCollection

Add error message relating to system state (not field-specific), and a reason.

Specified by:

addErrorMessage in interface ErrorCollection

Parameters:

message - Error message.

reason - Reason for the error.

addReason

public void addReason(ErrorCollection.Reason reason)

Description copied from interface: ErrorCollection

Add a reason why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

addReason in interface ErrorCollection

Parameters:

reason - a well known reasons why the function has not been performed.

addReasons

public void addReasons(Set<ErrorCollection.Reason> reasons)

Description copied from interface: ErrorCollection

Add reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

addReasons in interface ErrorCollection

Parameters:

reasons - a set of well known reasons why the function has not been performed.

setReasons

public void setReasons(Set<ErrorCollection.Reason> reasons)

Description copied from interface: ErrorCollection

Set reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

setReasons in interface ErrorCollection

Parameters:

reasons - a set of well known reasons why the function has not been performed.

getReasons

public Set<ErrorCollection.Reason> getReasons()

Description copied from interface: ErrorCollection

A set of well known reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Specified by:

getReasons in interface ErrorCollection

Returns:

a set of well known reasons why the function has not been performed.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object