org.apache.pivot.util

Enum Vote

java.lang.Object

java.lang.Enum<Vote>

org.apache.pivot.util.Vote

All Implemented Interfaces:

Serializable, Comparable<Vote>

public enum Vote
extends Enum<Vote>

Enumeration representing a vote. Votes are often used to determine the result of an event preview.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPROVE Represents an approval vote.
DEFER Represents a deferred vote, implying that the vote will be approved later.
DENY Represents a denial vote.

Method Summary

Methods

Modifier and Type	Method and Description
Vote	tally(Vote vote)
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

APPROVE

public static final Vote APPROVE

Represents an approval vote.

DENY

public static final Vote DENY

Represents a denial vote.

DEFER

public static final Vote DEFER

Represents a deferred vote, implying that the vote will be approved later.

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

tally

public Vote tally(Vote vote)