OpenJDK 1.23 · com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool

This interface specifies how the parser and the application interact with respect to Grammar objects that the application possesses--either by having precompiled them or by having stored them from a previous validation of an instance document. It makes no assumptions about the kind of Grammar involved, or about how the application's storage mechanism works.

The interaction works as follows:

When a validator considers a document, it is expected to request grammars of the type it can handle from this object using the retrieveInitialGrammarSet method.
If it requires a grammar not in this set, it will request it from this Object using the retrieveGrammar method.
After successfully validating an instance, the validator should make any new grammars it has compiled available to this object using the cacheGrammars method; for ease of implementation it may make other Grammars it holds references to as well (i.e., it may return some grammars that were retrieved from the GrammarPool in earlier operations).

Method Summary

Modifier and Type	Method 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) return the final set of grammars that the validator ended up with.
public void	clear() Removes all grammars from the pool.
public void	lockPool() Causes the XMLGrammarPool not to store any grammars when the cacheGrammars(String, Grammar[[]) method is called.
public Grammar	Returns: the Grammar corresponding to this description or null if no such Grammar is known. retrieveGrammar(XMLGrammarDescription The description of the Grammar being requested. desc) This method requests that the application retrieve a grammar corresponding to the given GrammarIdentifier from its cache.
public Grammar[]	Returns: the set of grammars the validator may put in its "bucket" retrieveInitialGrammarSet(String the type of the grammar, from the `com.sun.org.apache.xerces.internal.xni.grammars.Grammar` interface. grammarType) retrieve the initial known set of grammars.
public void	unlockPool() Allows the XMLGrammarPool to store grammars when its cacheGrammars(String, Grammar[]) method is called.

Method Detail

cacheGrammars	back to summary
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:String the type of the grammars being returned; grammars:Grammar[] an array containing the set of grammars being returned; order is not significant.

cacheGrammars

back to summary

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

clear	back to summary
public void clear() Removes all grammars from the pool.

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

retrieveGrammar	back to summary
public Grammar retrieveGrammar(XMLGrammarDescription desc) 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.

retrieveGrammar

back to summary

public Grammar retrieveGrammar(XMLGrammarDescription desc)

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.

retrieveInitialGrammarSet back to summary

retrieveInitialGrammarSet	back to summary
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:String the type of the grammar, from the `com.sun.org.apache.xerces.internal.xni.grammars.Grammar` interface. Returns:Grammar[] the set of grammars the validator may put in its "bucket"

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:String: the type of the grammar, from the com.sun.org.apache.xerces.internal.xni.grammars.Grammar interface.

Returns:Grammar[]

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

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

public Interface XMLGrammarPool

Method Summary

Method Detail