Package org.tweetyproject.agents.dialogues.oppmodels

Enum GroundedGameSystem.AgentFaction

java.lang.Object

java.lang.Enum<GroundedGameSystem.AgentFaction>

org.tweetyproject.agents.dialogues.oppmodels.GroundedGameSystem.AgentFaction

All Implemented Interfaces:

Serializable, Comparable<GroundedGameSystem.AgentFaction>, Constable

Enclosing class:

GroundedGameSystem

public static enum GroundedGameSystem.AgentFaction
extends Enum<GroundedGameSystem.AgentFaction>

The factions of agents in this game.

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
CONTRA	The faction that opposes the argument or proposition (Contra position).
PRO	The faction that supports the argument or proposition (Pro position).

Method Summary

Modifier and Type	Method	Description
GroundedGameSystem.AgentFaction	getComplement()	Returns the complement of the current faction.
static GroundedGameSystem.AgentFaction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GroundedGameSystem.AgentFaction[]	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

PRO

public static final GroundedGameSystem.AgentFaction PRO

The faction that supports the argument or proposition (Pro position).

CONTRA

public static final GroundedGameSystem.AgentFaction CONTRA

The faction that opposes the argument or proposition (Contra position).

Method Details

values

public static GroundedGameSystem.AgentFaction[] 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 GroundedGameSystem.AgentFaction 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

getComplement

public GroundedGameSystem.AgentFaction getComplement()

Returns the complement of the current faction. If the faction is CONTRA, the complement is PRO. If the faction is PRO, the complement is CONTRA.

Returns:

The complementary faction of this faction (either PRO or CONTRA).