ActorSuggestion (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.gui.flow.tree.ActorSuggestion

```
public class ActorSuggestion
extends Object
```
Class for suggesting actors when editing a flow, depending on the context.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`FILENAME`	the name of the props file.
`static String`	`KEY_DEFAULT`	the key for the default actor.
`protected Actor[]`	`m_Defaults`	the default actor(s).
`protected Properties`	`m_Properties`	the properties with the rules.
`protected String[]`	`m_Rules`	the valid rules.
`protected static ActorSuggestion`	`m_Singleton`	the singleton.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Actor[]`	`getDefaults()`	Returns the available default actors.
`static ActorSuggestion`	`getSingleton()`	Returns the singleton instance for suggesting actors.
`protected void`	`initialize()`	Initializes the rules engine for proposing actors.
`Actor[]`	`suggest(ActorSuggestion.SuggestionData context)`	Returns the suggested actors.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILENAME
```
public static final String FILENAME
```
    the name of the props file.
    
    See Also:
    
    Constant Field Values
  - KEY_DEFAULT
```
public static final String KEY_DEFAULT
```
    the key for the default actor.
    
    See Also:
    
    Constant Field Values
  - m_Properties
```
protected Properties m_Properties
```
    the properties with the rules.
  - m_Defaults
```
protected Actor[] m_Defaults
```
    the default actor(s).
  - m_Rules
```
protected String[] m_Rules
```
    the valid rules.
  - m_Singleton
```
protected static ActorSuggestion m_Singleton
```
    the singleton.
- Method Detail
  - initialize
```
protected void initialize()
```
    Initializes the rules engine for proposing actors.
  - getDefaults
```
public Actor[] getDefaults()
```
    Returns the available default actors.
    
    Returns:
    
    the default actors
  - suggest
```
public Actor[] suggest(ActorSuggestion.SuggestionData context)
```
    Returns the suggested actors.
    
    Parameters:
    
    context - the suggestion context
    
    Returns:
    
    the suggested actors
  - getSingleton
```
public static ActorSuggestion getSingleton()
```
    Returns the singleton instance for suggesting actors.
    
    Returns:
    
    the singleton