org.jvoicexml.implementation

Class DocumentGrammarImplementation

java.lang.Object

org.jvoicexml.implementation.DocumentGrammarImplementation

All Implemented Interfaces:

GrammarImplementation<GrammarDocument>

public final class DocumentGrammarImplementation
extends java.lang.Object
implements GrammarImplementation<GrammarDocument>

A grammar implementation that simply represents a grammar document. This may be suitable for all cases where there is no specific grammar implementation but an implementation that is simply based on documents.

Since:

0.7.3

Constructor Summary

Constructors

Constructor and Description
DocumentGrammarImplementation(GrammarDocument doc) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(GrammarImplementation<GrammarDocument> other) Checks if this grammar implementation is equal to the given grammar implementation.
GrammarDocument	getGrammarDocument() Retrieves the grammar document.
org.jvoicexml.xml.srgs.GrammarType	getMediaType() Returns the declared media type of the external grammar.
org.jvoicexml.xml.srgs.ModeType	getModeType() Returns the mode type of the grammar.
java.net.URI	getURI() Retrieves the URI of the grammar.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentGrammarImplementation

public DocumentGrammarImplementation(GrammarDocument doc)

Constructs a new object.

Parameters:

doc - the grammar document.

Method Detail

getURI

public java.net.URI getURI()

Retrieves the URI of the grammar.

Specified by:

getURI in interface GrammarImplementation<GrammarDocument>

Returns:

URI of the grammar document.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(GrammarImplementation<GrammarDocument> other)

Checks if this grammar implementation is equal to the given grammar implementation.

Specified by:

equals in interface GrammarImplementation<GrammarDocument>

Parameters:

other - the grammar implementation to compare with.

Returns:

true if the grammar implementations are equal.

getGrammarDocument

public GrammarDocument getGrammarDocument()

Retrieves the grammar document.

Specified by:

getGrammarDocument in interface GrammarImplementation<GrammarDocument>

Returns:

the grammar.

getMediaType

public org.jvoicexml.xml.srgs.GrammarType getMediaType()

Returns the declared media type of the external grammar.

Specified by:

getMediaType in interface GrammarImplementation<GrammarDocument>

Returns:

The media type of the grammar file.

getModeType

public org.jvoicexml.xml.srgs.ModeType getModeType()

Returns the mode type of the grammar.

Specified by:

getModeType in interface GrammarImplementation<GrammarDocument>

Returns:

mode type of the grammar.