AgentState (SARL Agent Oriented Programming Language 0.12.0 API)

All Implemented Interfaces:

Serializable, Comparable<AgentState>
```
public enum AgentState
extends Enum<AgentState>
```
Describe the states of an agent.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALIVE` The owner of the event bus is running.
`DEAD` The owner of the event bus was destroyed.
`DYING` The owner of the event bus is under destruction.
`INITIALIZING` The agent is under creation.
`UNSTARTED` The agent is unstarted: before initialization process.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`isAlive()` Replies if the state is one of the living states (initializing and alive).
`abstract boolean`	`isAsynchronousEventHandling()` Replies if the state accepts asynchronous event handling.
`abstract boolean`	`isBlockingEventHandling()` Replies if the state accepts blocking event handling.
`abstract boolean`	`isPostAlive()` Replies if the state is after the agent life.
`abstract boolean`	`isPreAlive()` Replies if the state is before the agent life.
`static AgentState`	`valueOf(name : String)` Returns the enum constant of this type with the specified name.
`static AgentState[]`	`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
  - UNSTARTED
```
public static final AgentState UNSTARTED
```
    The agent is unstarted: before initialization process.
  - INITIALIZING
```
public static final AgentState INITIALIZING
```
    The agent is under creation.
  - ALIVE
```
public static final AgentState ALIVE
```
    The owner of the event bus is running.
  - DYING
```
public static final AgentState DYING
```
    The owner of the event bus is under destruction.
  - DEAD
```
public static final AgentState DEAD
```
    The owner of the event bus was destroyed.
- Method Detail
  - values
```
public static def values() : AgentState[] 
```
    Description copied from class: AgentState
    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 (AgentState c : AgentState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static def valueOf(name : String) : AgentState 
```
    Description copied from class: AgentState
    
    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
  - isAsynchronousEventHandling
```
public abstract def isAsynchronousEventHandling() : boolean 
```
    Description copied from class: AgentState
    
    Replies if the state accepts asynchronous event handling.
    
    Returns:
    
    true if the state accept event handling.
    
    Since:
    
    0.5
  - isBlockingEventHandling
```
public abstract def isBlockingEventHandling() : boolean 
```
    Description copied from class: AgentState
    
    Replies if the state accepts blocking event handling.
    
    Returns:
    
    true if the state accept block event handling.
    
    Since:
    
    0.5
  - isAlive
```
public abstract def isAlive() : boolean 
```
    Description copied from class: AgentState
    
    Replies if the state is one of the living states (initializing and alive).
    
    Returns:
    
    true if the state is an agent life state.
    
    Since:
    
    0.7
  - isPreAlive
```
public abstract def isPreAlive() : boolean 
```
    Description copied from class: AgentState
    
    Replies if the state is before the agent life.
    
    Returns:
    
    true if the state is before the agent life.
    
    Since:
    
    0.7
  - isPostAlive
```
public abstract def isPostAlive() : boolean 
```
    Description copied from class: AgentState
    
    Replies if the state is after the agent life.
    
    Returns:
    
    true if the state is after the agent life.
    
    Since:
    
    0.5

Enum AgentState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNSTARTED

INITIALIZING

ALIVE

DYING

DEAD

Method Detail

values

valueOf

isAsynchronousEventHandling

isBlockingEventHandling

isAlive

isPreAlive

isPostAlive