Package madkit.action

# Enum Class AgentAction

java.lang.Object
java.lang.Enum<AgentAction>
madkit.action.AgentAction

All Implemented Interfaces:
  `Serializable`, `Comparable<AgentAction>`, `java.lang.constant.Constable`

public enum AgentAction extends Enum<AgentAction>
Enum representing agent actions

Since:
  MaDKit 5.0.0.14
Version:
  0.9
Author:
  Fabien Michel

- ## 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
  `BROADCAST_MESSAGE`
  `CREATE_GROUP`
  `KILL_AGENT`
  `LAUNCH_AGENT`
  `LEAVE_GROUP`
  `LEAVE_ROLE`
  `RELOAD`
  `REQUEST_ROLE`
  `SEND_MESSAGE`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Action`
  `getActionFor(AbstractAgent agent, Object... parameters)`
  Builds an action that will make the agent do the corresponding behavior
  `ActionInfo`
  `getActionInfo()`
  `static AgentAction`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static AgentAction[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### LAUNCH_AGENT

    public static final AgentAction LAUNCH_AGENT

  - ### RELOAD

    public static final AgentAction RELOAD

  - ### CREATE_GROUP

    public static final AgentAction CREATE_GROUP

  - ### REQUEST_ROLE

    public static final AgentAction REQUEST_ROLE

  - ### LEAVE_ROLE

    public static final AgentAction LEAVE_ROLE

  - ### LEAVE_GROUP

    public static final AgentAction LEAVE_GROUP

  - ### SEND_MESSAGE

    public static final AgentAction SEND_MESSAGE

  - ### BROADCAST_MESSAGE

    public static final AgentAction BROADCAST_MESSAGE

  - ### KILL_AGENT

    public static final AgentAction KILL_AGENT

- ## Method Details

  - ### values

    public static AgentAction[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static AgentAction valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### getActionInfo

    public ActionInfo getActionInfo()
    Returns:
      the `ActionInfo` corresponding to this constant

  - ### getActionFor

    public Action getActionFor(AbstractAgent agent, Object... parameters)
    Builds an action that will make the agent do the corresponding behavior
    Parameters:
      `agent` - the agent on which this action will operate
      `parameters` - the info to be used
    Returns:
      the action corresponding to the enum