Package com.almworks.jira.structure.api.error

Enum Class StructureErrorCategory

Object

Enum<StructureErrorCategory>

StructureErrorCategory

All Implemented Interfaces:

Serializable, Comparable<StructureErrorCategory>, Constable

@PublicApi
public enum StructureErrorCategory
extends Enum<StructureErrorCategory>

Defines categories for errors that may be reported by Structure and its extensions.

See Also:

• StructureError
• StructureErrors
• StructureException

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GENERAL	Default category for general errors.
INTERNAL	Errors in this category mean that there was some problem with JIRA, Structure or Structure extension internals.
INVALID_INPUT	Errors in this category are caused by user input, whether immediately preceding the unsuccessful action, or entered previously.
NO_PERMISSION	This category contains errors that are caused by the actor not having sufficient permissions for the action.
NOT_FOUND	This category contains errors that mean that the requested object is either not found, does not exist anymore or the user does not have access to it.

Method Summary

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

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GENERAL

public static final StructureErrorCategory GENERAL

Default category for general errors.

INVALID_INPUT

public static final StructureErrorCategory INVALID_INPUT

Errors in this category are caused by user input, whether immediately preceding the unsuccessful action, or entered previously.

NO_PERMISSION

public static final StructureErrorCategory NO_PERMISSION

This category contains errors that are caused by the actor not having sufficient permissions for the action.

NOT_FOUND

public static final StructureErrorCategory NOT_FOUND

This category contains errors that mean that the requested object is either not found, does not exist anymore or the user does not have access to it.

INTERNAL

public static final StructureErrorCategory INTERNAL

Errors in this category mean that there was some problem with JIRA, Structure or Structure extension internals. The text of the error is typically not shown to the user but reported to support.

Method Details

values

public static StructureErrorCategory[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StructureErrorCategory valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null