com.adobe.cq.social.tally.client.api

Enum Vote

java.lang.Object

java.lang.Enum<Vote>

com.adobe.cq.social.tally.client.api.Vote

All Implemented Interfaces:

ResponseValue, Serializable, Comparable<Vote>

public enum Vote
extends Enum<Vote>
implements ResponseValue

Represents the vote given by a user.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISLIKE A negative vote.
LIKE A positive vote.

Method Summary

Modifier and Type	Method and Description
String	getResponseValue()
static Vote	getVoteByResponseValue(String responseValue)
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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LIKE

public static final Vote LIKE

A positive vote.

DISLIKE

public static final Vote DISLIKE

A negative vote.

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

getResponseValue

public String getResponseValue()

Specified by:

getResponseValue in interface ResponseValue

Returns:

the string value of the response

getVoteByResponseValue

public static Vote getVoteByResponseValue(String responseValue)

Parameters:

responseValue - String representation of the Vote value

Returns:

a strongly typed Vote value representing the response value