com.atlassian.gadgets.spi
Enum Vote

java.lang.Object
  java.lang.Enum<Vote>
      com.atlassian.gadgets.spi.Vote

All Implemented Interfaces:

Serializable, Comparable<Vote>

public enum Vote
extends Enum<Vote>

Votes are used in the gadget system to determine whether a user is allowed to perform certain actions, such as seeing a gadget in the gadget browser or being allowed to render a gadget on their dashboard.

Enum Constant Summary

ALLOW
The user is allowed to perform the requested action.

DENY
The user is forbidden to perform the requested action.

PASS
The implementation has no opinion on whether the user may perform the requested action.

Method Summary

static Vote	valueOf(String name) Returns the enum constant of this type with the specified name.
static Vote[]	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

ALLOW

public static final Vote ALLOW

The user is allowed to perform the requested action.

DENY

public static final Vote DENY

The user is forbidden to perform the requested action.

PASS

public static final Vote PASS

The implementation has no opinion on whether the user may perform the requested action.

Method Detail

values

public static Vote[] 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 (Vote c : Vote.values())
    System.out.println(c);

Returns:

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

valueOf

public static Vote 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