Top Description Fields Constructors Methods
org.apache.xerces.jaxp.validation

pack-priv final Class ReadOnlyGrammarPool

extends Object
implements XMLGrammarPool
Class Inheritance
All Implemented Interfaces
org.apache.xerces.xni.grammars.XMLGrammarPool
Imports
org.apache.xerces.xni.grammars.Grammar, .XMLGrammarDescription, .XMLGrammarPool

Filter XMLGrammarPool that exposes a read-only view of the underlying pool.

Author
Kohsuke Kawaguchi ([email protected])
Version
$Id: ReadOnlyGrammarPool.java 447235 2006-09-18 05:01:44Z mrglavas $

Field Summary

Modifier and TypeField and Description
private final XMLGrammarPool
core

Constructor Summary

AccessConstructor and Description
public
ReadOnlyGrammarPool(XMLGrammarPool pool)

Method Summary

Modifier and TypeMethod and Description
public void
cacheGrammars(String
the type of the grammars being returned;
grammarType, Grammar[]
an array containing the set of grammars being returned; order is not significant.
grammars)

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.cacheGrammars.

return the final set of grammars that the validator ended up with.

public void
clear()

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.clear.

Removes all grammars from the pool.
public void
lockPool()

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.lockPool.

Causes the XMLGrammarPool not to store any grammars when the cacheGrammars(String, Grammar[[]) method is called.
public Grammar
retrieveGrammar(XMLGrammarDescription
The description of the Grammar being requested.
desc)

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.retrieveGrammar.

This method requests that the application retrieve a grammar corresponding to the given GrammarIdentifier from its cache.

public Grammar[]
retrieveInitialGrammarSet(String
the type of the grammar, from the org.apache.xerces.xni.grammars.Grammar interface.
grammarType)

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.retrieveInitialGrammarSet.

retrieve the initial known set of grammars.

public void
unlockPool()

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.unlockPool.

Allows the XMLGrammarPool to store grammars when its cacheGrammars(String, Grammar[]) method is called.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

coreback to summary
private final XMLGrammarPool core

Constructor Detail

ReadOnlyGrammarPoolback to summary
public ReadOnlyGrammarPool(XMLGrammarPool pool)

Method Detail

cacheGrammarsback to summary
public void cacheGrammars(String grammarType, Grammar[] grammars)

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.cacheGrammars.

Doc from org.apache.xerces.xni.grammars.XMLGrammarPool.cacheGrammars.

return the final set of grammars that the validator ended up with. This method is called after the validation finishes. The application may then choose to cache some of the returned grammars.

Parameters
grammarType:String

the type of the grammars being returned;

grammars:Grammar[]

an array containing the set of grammars being returned; order is not significant.

clearback to summary
public void clear()

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.clear.

Doc from org.apache.xerces.xni.grammars.XMLGrammarPool.clear.

Removes all grammars from the pool.

lockPoolback to summary
public void lockPool()

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.lockPool.

Doc from org.apache.xerces.xni.grammars.XMLGrammarPool.lockPool.

Causes the XMLGrammarPool not to store any grammars when the cacheGrammars(String, Grammar[[]) method is called.

retrieveGrammarback to summary
public Grammar retrieveGrammar(XMLGrammarDescription desc)

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.retrieveGrammar.

Doc from org.apache.xerces.xni.grammars.XMLGrammarPool.retrieveGrammar.

This method requests that the application retrieve a grammar corresponding to the given GrammarIdentifier from its cache. If it cannot do so it must return null; the parser will then call the EntityResolver. An application must not call its EntityResolver itself from this method; this may result in infinite recursions.

Parameters
desc:XMLGrammarDescription

The description of the Grammar being requested.

Returns:Grammar

the Grammar corresponding to this description or null if no such Grammar is known.

retrieveInitialGrammarSetback to summary
public Grammar[] retrieveInitialGrammarSet(String grammarType)

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.retrieveInitialGrammarSet.

Doc from org.apache.xerces.xni.grammars.XMLGrammarPool.retrieveInitialGrammarSet.

retrieve the initial known set of grammars. this method is called by a validator before the validation starts. the application can provide an initial set of grammars available to the current validation attempt.

Parameters
grammarType:String

the type of the grammar, from the org.apache.xerces.xni.grammars.Grammar interface.

Returns:Grammar[]

the set of grammars the validator may put in its "bucket"

unlockPoolback to summary
public void unlockPool()

Implements org.apache.xerces.xni.grammars.XMLGrammarPool.unlockPool.

Doc from org.apache.xerces.xni.grammars.XMLGrammarPool.unlockPool.

Allows the XMLGrammarPool to store grammars when its cacheGrammars(String, Grammar[]) method is called. This is the default state of the object.