org.jvoicexml.interpreter.scope

Class ScopedSet<E>

java.lang.Object

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

Type Parameters:

E - Type of the elements in this set.

All Implemented Interfaces:

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

public final class ScopedSet<E>
extends java.lang.Object
implements ScopeSubscriber, java.util.Set<E>

A simple Set which is scope aware.

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

Since:

0.7.2

Constructor Summary

Constructors

Constructor and Description
ScopedSet(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	addScopedSetObserver(ScopedSetObserver<E> obs) Adds the given observer to the list of known observers.
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)
void	removeScopedSetObserver(ScopedSetObserver<E> obs) Removes the given scope observer from the list of known observers.
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.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ScopedSet

public ScopedSet(ScopeObserver scopeObserver)

Constructs a new object.

Parameters:

scopeObserver - The current scope observer.

Method Detail

addScopedSetObserver

public void addScopedSetObserver(ScopedSetObserver<E> obs)

Adds the given observer to the list of known observers.

Parameters:

obs - the observer to add

Since:

0.7.3

removeScopedSetObserver

public void removeScopedSetObserver(ScopedSetObserver<E> obs)

Removes the given scope observer from the list of known observers.

Parameters:

obs - the observer to remove

Since:

0.7.3

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>

Specified by:

add in interface java.util.Set<E>

addAll

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

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Set<E>

containsAll

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

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.Set<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.Set<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>

Specified by:

iterator in interface java.util.Set<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

removeAll

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

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.Set<E>

retainAll

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

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.Set<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.Set<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

toArray

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

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>