org.jvoicexml.interpreter.scope

Class ScopeObserver

java.lang.Object

org.jvoicexml.interpreter.scope.ScopeObserver

All Implemented Interfaces:

ScopePublisher

public final class ScopeObserver
extends java.lang.Object
implements ScopePublisher

Central that gets notified about scope changes. A ScopeObserver is bound to a session and manages the scope changes of a user within the session.

All scopes are maintained in a stack. If the ScopeObserver gets notified about entering a new scope, the new scope is pushed a the top of this stack. Exiting a scope will cause the observer to remove the exited scope from the stack.

Since:

0.3

Constructor Summary

Constructors

Constructor and Description
ScopeObserver() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	addScopeSubscriber(ScopeSubscriber subscriber) Add the given subscriber to the list of known ScopeSubscribers.
Scope	currentScope() Retrieve the current scope.
void	enterScope(Scope scope) The application has entered the given scope.
void	exitScope(Scope scope) The application has left the given scope.
void	removeScopeSubscriber(ScopeSubscriber subscriber) Remove the given subscriber from the list of known ScopeSubscribers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScopeObserver

public ScopeObserver()

Constructs a new object.

Method Detail

enterScope

public void enterScope(Scope scope)

The application has entered the given scope.

Parameters:

scope - The new scope.

exitScope

public void exitScope(Scope scope)

The application has left the given scope.

Parameters:

scope - The scope to exit.

currentScope

public Scope currentScope()

Retrieve the current scope.

Returns:

The current scope, null if there is none.

addScopeSubscriber

public void addScopeSubscriber(ScopeSubscriber subscriber)

Add the given subscriber to the list of known ScopeSubscribers.

Specified by:

addScopeSubscriber in interface ScopePublisher

Parameters:

subscriber - The subscriber to add.

removeScopeSubscriber

public void removeScopeSubscriber(ScopeSubscriber subscriber)

Remove the given subscriber from the list of known ScopeSubscribers.

Specified by:

removeScopeSubscriber in interface ScopePublisher

Parameters:

subscriber - The subscriber to remove.