AbstractActorSwapSuggestion (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.flow.tree.actorswap.AbstractActorSwapSuggestion

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

ActorHandlerSuggestion, SimpleSuggestion
```
public abstract class AbstractActorSwapSuggestion
extends AbstractOptionHandler
```
Ancestor for classes the return potential swaps for an actor.
Make sure that the options get transferred as well, by having the appropriate AbstractOptionTransfer class(es) in place.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected static Logger LOGGER
the logger for static methods.

protected static HashMap<Class,List<Actor>> m_Cache
for caching suggestions.
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractActorSwapSuggestion()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract List<Actor>`	`doSuggest(Actor current)`	Performs the actual search for candidates.
`List<Actor>`	`suggest(Actor current)`	Searches for potential candidates for swaps.
`static List<Actor>`	`suggestAll(Actor current)`	Searches for potential candidates for swaps.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - LOGGER
```
protected static Logger LOGGER
```
    the logger for static methods.
  - m_Cache
```
protected static HashMap<Class,List<Actor>> m_Cache
```
    for caching suggestions.
- Constructor Detail
  - AbstractActorSwapSuggestion
```
public AbstractActorSwapSuggestion()
```
- Method Detail
  - doSuggest
```
protected abstract List<Actor> doSuggest(Actor current)
```
    Performs the actual search for candidates.
    
    Parameters:
    
    current - the actor to find potential swaps for
    
    Returns:
    
    the list of potential swaps
  - suggest
```
public List<Actor> suggest(Actor current)
```
    Searches for potential candidates for swaps.
    
    Parameters:
    
    current - the actor to find potential swaps for
    
    Returns:
    
    the list of potential swaps
  - suggestAll
```
public static List<Actor> suggestAll(Actor current)
```
    Searches for potential candidates for swaps. Applies all potential swap suggestions and combines the results.
    
    Parameters:
    
    current - the actor to find potential swaps for
    
    Returns:
    
    the list of potential swaps