Package org.apache.pivot.util

Enum Vote

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Vote>
    public enum Vote
extends java.lang.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 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Vote tally​(Vote vote)
      Tally a new vote against the previous tally result.
      static Vote valueOf​(java.lang.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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • tally

        public Vote tally​(Vote vote)
        Tally a new vote against the previous tally result. For a vote tally to work correctly the initial value must be APPROVE.

        The tallying algorithm is as follows:

        • New vote is APPROVE -> result is previous result.
        • New vote is DENY -> result is new vote (that is, DENY).
        • New vote is DEFER -> result is DENY if previous was DENY, otherwise DEFER.
        Parameters:
        vote - The new vote to tally.
        Returns:
        The result of tallying this new vote against this previously accumulated result.
        Throws:
        java.lang.IllegalArgumentException - if the new vote is null.