Package com.chatmotorapi.api.functional

Enum SentimentType

java.lang.Object

java.lang.Enum<SentimentType>

com.chatmotorapi.api.functional.SentimentType

All Implemented Interfaces:

Serializable, Comparable<SentimentType>, java.lang.constant.Constable

public enum SentimentType
extends Enum<SentimentType>

Enum representing the possible sentiment types for sentiment analysis, each associated with an integer value.

The integer values can be used for easier comparisons, storage, and numerical calculations such as averaging sentiment scores.

• Positive sentiment: 1
• Negative sentiment: -1
• Neutral sentiment: 0

Since:

1.2

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NEGATIVE	Represents a negative sentiment.
NEUTRAL	Represents a neutral sentiment.
POSITIVE	Represents a positive sentiment.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the integer value associated with this sentiment type.
static SentimentType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SentimentType[]	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, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

POSITIVE

public static final SentimentType POSITIVE

Represents a positive sentiment. Associated with value 1.

NEGATIVE

public static final SentimentType NEGATIVE

Represents a negative sentiment. Associated with value -1.

NEUTRAL

public static final SentimentType NEUTRAL

Represents a neutral sentiment. Associated with value 0.

Method Details

values

public static SentimentType[] values()

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

Returns:

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

valueOf

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

getValue

public int getValue()

Gets the integer value associated with this sentiment type.

Returns:

the integer value representing the sentiment