DefaultMonitor (Scribble::Docs::Javadoc 0.3.0.Final API)

java.lang.Object
- org.scribble.monitor.DefaultMonitor

All Implemented Interfaces:

Monitor
```
public class DefaultMonitor
extends Object
implements Monitor
```
This class represents the monitorable version of a local protocol.

Constructor Summary

Constructors
Constructor and Description

DefaultMonitor()

Constructors
Constructor and Description
`DefaultMonitor()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkScope(SessionType type, SessionScope scope, SessionScope subScope, int scopeIndex)` This method checks a sub-scope to see whether it has completed, and if so, remove it from the parent scope and initiate any optional completion node.
`void`	`initializeInstance(SessionType type, SessionInstance instance)` This method initializes a session instance based on the supplied session type.
`boolean`	`received(SessionType type, SessionInstance instance, Message message, String fromRole)` This method checks whether the received message is valid.
`protected boolean`	`received(SessionType type, SessionScope scope, Message message, String fromRole)` This method checks whether the received message is applicable to the supplied session scope or any of its child scopes.
`boolean`	`sent(SessionType type, SessionInstance instance, Message message, String toRole)` This method checks whether the sent message is valid.
`protected boolean`	`sent(SessionType type, SessionScope scope, Message message, String toRole)` This method checks whether the sent message is applicable to the supplied session scope or any of its child scopes.

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

- Constructor Detail
  - DefaultMonitor
```
public DefaultMonitor()
```
- Method Detail
  - initializeInstance
```
public void initializeInstance(SessionType type,
                      SessionInstance instance)
```
    This method initializes a session instance based on the supplied session type.
    
    Specified by:
    
    initializeInstance in interface Monitor
    
    Parameters:
    type - The session type
    instance - The session instance
  - sent
```
public boolean sent(SessionType type,
           SessionInstance instance,
           Message message,
           String toRole)
```
    This method checks whether the sent message is valid.
    
    Specified by:
    
    sent in interface Monitor
    
    Parameters:
    type - The session type
    instance - The session instance
    message - The message
    toRole - The optional 'to' role
    
    Returns:
    Whether the sent message was expected
  - sent
```
protected boolean sent(SessionType type,
           SessionScope scope,
           Message message,
           String toRole)
```
    This method checks whether the sent message is applicable to the supplied session scope or any of its child scopes.
    
    Parameters:
    type - The session type
    scope - The session scope
    message - The message
    toRole - The optional 'to' role
    
    Returns:
    Whether the sent message is applicable to the scope
  - received
```
public boolean received(SessionType type,
               SessionInstance instance,
               Message message,
               String fromRole)
```
    This method checks whether the received message is valid.
    
    Specified by:
    
    received in interface Monitor
    
    Parameters:
    type - The session type
    instance - The session instance
    message - The message
    fromRole - The optional 'from' role
    
    Returns:
    Whether the received message was expected
  - received
```
protected boolean received(SessionType type,
               SessionScope scope,
               Message message,
               String fromRole)
```
    This method checks whether the received message is applicable to the supplied session scope or any of its child scopes.
    
    Parameters:
    type - The session type
    scope - The session scope
    message - The message
    fromRole - The optional 'from' role
    
    Returns:
    Whether the sent message is applicable to the scope
  - checkScope
```
protected void checkScope(SessionType type,
              SessionScope scope,
              SessionScope subScope,
              int scopeIndex)
```
    This method checks a sub-scope to see whether it has completed, and if so, remove it from the parent scope and initiate any optional completion node.
    
    Parameters:
    type - The session type
    scope - The parent scope
    subScope - The sub scope to check
    scopeIndex - The sub-scope's index within the parent scope

Class DefaultMonitor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultMonitor

Method Detail

initializeInstance

sent

sent

received

received

checkScope