APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xerces.internal.jaxp.validation

pack-priv final Class ReadOnlyGrammarPool

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

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

Author
Kohsuke Kawaguchi

Field Summary

Modifier and TypeField and Description
private final XMLGrammarPool

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
cacheGrammars(String grammarType, Grammar[] grammars)

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.cacheGrammars.

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

public void
clear()

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.clear.

Removes all grammars from the pool.

public void
lockPool()

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.lockPool.

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

public Grammar
retrieveGrammar(XMLGrammarDescription desc)

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.retrieveGrammar.

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

public Grammar[]
public void
unlockPool()

Implements com.sun.org.apache.xerces.internal.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 com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.cacheGrammars.

Doc from com.sun.org.apache.xerces.internal.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.

clearback to summary
public void clear()

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.clear.

Doc from com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.clear.

Removes all grammars from the pool.

lockPoolback to summary
public void lockPool()

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.lockPool.

Doc from com.sun.org.apache.xerces.internal.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 com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.retrieveGrammar.

Doc from com.sun.org.apache.xerces.internal.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.

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

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.retrieveInitialGrammarSet.

Doc from com.sun.org.apache.xerces.internal.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.

unlockPoolback to summary
public void unlockPool()

Implements com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool.unlockPool.

Doc from com.sun.org.apache.xerces.internal.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.