org.jvoicexml.interpreter.scope

Class ScopedCollection<E>

java.lang.Object

org.jvoicexml.interpreter.scope.ScopedCollection<E>

Type Parameters:

E - Type of the elements in this collection.

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, ScopeSubscriber

public final class ScopedCollection<E>
extends java.lang.Object
implements ScopeSubscriber, java.util.Collection<E>

A simple Collection which is scope aware.

This enables the user to store a collection and retrieve these values without taking care about scope changes. The values are always scope aware.

Views onto this collection, like iterating over its elements, will always return those elements from the topmost scope prior to elements from lower scopes.

Since:

0.6

Constructor Summary

Constructors

Constructor and Description
ScopedCollection(ScopeObserver scopeObserver) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
boolean	addAll(java.util.Collection<? extends E> c)
void	clear()
void	close() Unsubscribe this scoped container from the ScopePublisher.
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
void	enterScope(Scope previous, Scope next) The application has entered the next scope and the previous scope is no more the current scope.
void	exitScope(Scope previous, Scope next) The application has left the previous scope and the next scope is valid.
boolean	isEmpty()
java.util.Iterator<E>	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ScopedCollection

public ScopedCollection(ScopeObserver scopeObserver)

Constructs a new object.

Parameters:

scopeObserver - The current scope observer.

Method Detail

close

public void close()

Unsubscribe this scoped container from the ScopePublisher.

enterScope

public void enterScope(Scope previous,
                       Scope next)

The application has entered the next scope and the previous scope is no more the current scope.

Specified by:

enterScope in interface ScopeSubscriber

Parameters:

previous - the old scope.

next - The new scope.

exitScope

public void exitScope(Scope previous,
                      Scope next)

The application has left the previous scope and the next scope is valid.

Specified by:

exitScope in interface ScopeSubscriber

Parameters:

previous - the old scope.

next - the new scope.

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.Collection<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<E>