public static final class

CachingParserPool.SynchronizedGrammarPool

extends Object
implements XMLGrammarPool
java.lang.Object
   ↳ org.apache.xerces.parsers.CachingParserPool.SynchronizedGrammarPool

Class Overview

Synchronized grammar pool.

Summary

Public Constructors
CachingParserPool.SynchronizedGrammarPool(XMLGrammarPool grammarPool)
Constructs a synchronized grammar pool.
Public Methods
void cacheGrammars(String grammarType, Grammar[] grammars)

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

void clear()
clear the grammar pool
void lockPool()
lock the grammar pool
Grammar retrieveGrammar(XMLGrammarDescription gDesc)

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

Grammar[] retrieveInitialGrammarSet(String grammarType)

retrieve the initial known set of grammars.

void unlockPool()
unlock the grammar pool
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xerces.xni.grammars.XMLGrammarPool

Public Constructors

public CachingParserPool.SynchronizedGrammarPool (XMLGrammarPool grammarPool)

Constructs a synchronized grammar pool.

Public Methods

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

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 the type of the grammars being returned;
grammars an array containing the set of grammars being returned; order is not significant.

public void clear ()

clear the grammar pool

public void lockPool ()

lock the grammar pool

public Grammar retrieveGrammar (XMLGrammarDescription gDesc)

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
gDesc The description of the Grammar being requested.
Returns
  • the Grammar corresponding to this description or null if no such Grammar is known.

public Grammar[] retrieveInitialGrammarSet (String grammarType)

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 the type of the grammar, from the org.apache.xerces.xni.grammars.Grammar interface.
Returns
  • the set of grammars the validator may put in its "bucket"

public void unlockPool ()

unlock the grammar pool