CallableNamesRecorder (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.flow.core.CallableNamesRecorder

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Serializable
```
public class CallableNamesRecorder
extends LoggingObject
```
Records callables to check for duplicates.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,Set<String>>`	`m_FullNames`	the full names recorded to so far (per parent full name of actor reference handler).
`protected Map<String,Set<String>>`	`m_Names`	the names recorded so far (per parent full name of actor reference handler).

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

CallableNamesRecorder()
Initializes the recorder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(ActorHandler handler, Actor actor)`	Adds the name to the recorded ones.
`void`	`clear()`	Clears the recorded data.
`boolean`	`contains(ActorHandler handler, Actor actor)`	Checks whether the name of the actor is already in use.
`protected String`	`generateKey(ActorHandler handler)`	Generates the key for the handler.

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, toString, wait, wait, wait

- Field Detail
  - m_Names
```
protected Map<String,Set<String>> m_Names
```
    the names recorded so far (per parent full name of actor reference handler).
  - m_FullNames
```
protected Map<String,Set<String>> m_FullNames
```
    the full names recorded to so far (per parent full name of actor reference handler).
- Constructor Detail
  - CallableNamesRecorder
```
public CallableNamesRecorder()
```
    Initializes the recorder.
- Method Detail
  - clear
```
public void clear()
```
    Clears the recorded data.
  - generateKey
```
protected String generateKey(ActorHandler handler)
```
    Generates the key for the handler.
    
    Parameters:
    
    handler - the handler to generate the key for
    
    Returns:
    
    the key
  - contains
```
public boolean contains(ActorHandler handler,
                        Actor actor)
```
    Checks whether the name of the actor is already in use.
    
    Parameters:
    
    handler - the handler for the actor
    
    actor - the actor to check
    
    Returns:
    
    true if already in use
  - add
```
public void add(ActorHandler handler,
                Actor actor)
```
    Adds the name to the recorded ones.
    
    Parameters:
    
    handler - the handler for the actor
    
    actor - the actor to add