Package com.almworks.jira.structure.api.row

Enum Class ItemAccessMode

Object

Enum<ItemAccessMode>

ItemAccessMode

All Implemented Interfaces:

Serializable, Comparable<ItemAccessMode>, Constable

public enum ItemAccessMode
extends Enum<ItemAccessMode>

These values may be used to optimize the access to StructureRow, based on whether the client code is going to use the StructureRow.getItem(java.lang.Class<I>) method or not, and whether it is important that the current user has access to that item.

See Also:

• RowRetriever

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ITEM_NOT_NEEDED	The caller indicates that StructureRow.getItem(java.lang.Class<I>) is not going to be called on the received structure row.
NORMAL_ACCESS	The provided structure row will exhibit normal behavior.
SKIP_ACCESS_CHECK	The caller indicates that StructureRow.getItem(java.lang.Class<I>) will be called, but the implementation should skip whatever access check it might do.

Method Summary

Modifier and Type	Method	Description
static ItemAccessMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ItemAccessMode[]	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

NORMAL_ACCESS

public static final ItemAccessMode NORMAL_ACCESS

The provided structure row will exhibit normal behavior. When coming from a regular row source, it means that when StructureRow.getItem(java.lang.Class<I>) is called, the user's access is going to be checked and the method will return null if the user has no access.

ITEM_NOT_NEEDED

public static final ItemAccessMode ITEM_NOT_NEEDED

The caller indicates that StructureRow.getItem(java.lang.Class<I>) is not going to be called on the received structure row. It's up to the implementation to decide what to do. The result of StructureRow.getItem(java.lang.Class<I>), should it be called, is undefined.

SKIP_ACCESS_CHECK

public static final ItemAccessMode SKIP_ACCESS_CHECK

The caller indicates that StructureRow.getItem(java.lang.Class<I>) will be called, but the implementation should skip whatever access check it might do. This is typically done when the permission to access the item by the current user has been already established.

Method Details

values

public static ItemAccessMode[] 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 ItemAccessMode 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