org.jvoicexml.implementation.grammar

Class GrammarCache

java.lang.Object

org.jvoicexml.implementation.grammar.GrammarCache

public final class GrammarCache
extends java.lang.Object

The grammars that have been processed by the grammar processor.

Since:

0.7.2

Constructor Summary

Constructors

Constructor and Description
GrammarCache() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	add(LoadedGrammar grammar) Adds the given grammar to the active grammar set.
boolean	contains(GrammarDocument document) Checks if the active grammar set contains the given grammar document.
boolean	contains(GrammarImplementation<?> implementation) Checks if the active grammar set contains the given grammar implementation.
LoadedGrammar	get(GrammarDocument document) Retrieves the processed grammar for the given document.
GrammarImplementation<?>	getImplementation(GrammarDocument document) Retrieves the cached implementation of the give grammar document.
java.util.Collection<GrammarImplementation<?>>	getImplementations() Retrieves the set of active grammar implementations.
int	size() Retrieves the number of active grammars.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrammarCache

public GrammarCache()

Constructs a new object.

Method Detail

size

public int size()

Retrieves the number of active grammars.

Returns:

number of active grammars

add

public void add(LoadedGrammar grammar)

Adds the given grammar to the active grammar set.

Parameters:

grammar - the grammar to add

getImplementations

public java.util.Collection<GrammarImplementation<?>> getImplementations()

Retrieves the set of active grammar implementations.

Returns:

set of active grammar implementations.

get

public LoadedGrammar get(GrammarDocument document)

Retrieves the processed grammar for the given document.

Parameters:

document - the grammar document to look for

Returns:

the processed grammar, null if there is no processed grammar.

getImplementation

public GrammarImplementation<?> getImplementation(GrammarDocument document)

Retrieves the cached implementation of the give grammar document.

Parameters:

document - the document

Returns:

cached implementation, maybe null

Since:

0.7.7

contains

public boolean contains(GrammarDocument document)

Checks if the active grammar set contains the given grammar document.

Parameters:

document - the grammar document to look for.

Returns:

true if the active grammar set contains the given grammar document

contains

public boolean contains(GrammarImplementation<?> implementation)

Checks if the active grammar set contains the given grammar implementation.

Parameters:

implementation - the grammar implementation to look for.

Returns:

true if the active grammar set contains the given grammar implementation