org.kohsuke.rngom.binary

Class SchemaBuilderImpl.GrammarImpl

java.lang.Object

org.kohsuke.rngom.binary.SchemaBuilderImpl.GrammarImpl

All Implemented Interfaces:

Div, Grammar, GrammarSection, IncludedGrammar, Scope

Enclosing class:

SchemaBuilderImpl

static class SchemaBuilderImpl.GrammarImpl
extends java.lang.Object
implements Grammar, Div, IncludedGrammar

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Hashtable	defines
private Scope	parent
private SchemaBuilderImpl	sb
private RefPattern	startRef

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GrammarImpl(SchemaBuilderImpl sb, SchemaBuilderImpl.GrammarImpl g)
private	GrammarImpl(SchemaBuilderImpl sb, Scope parent)

Method Summary

Modifier and Type	Method and Description
private void	define(RefPattern rp, GrammarSection.Combine combine, ParsedPattern pattern, Location loc)
void	define(java.lang.String name, GrammarSection.Combine combine, ParsedPattern pattern, Location loc, Annotations anno) Called when a pattern is defined.
void	endDiv(Location loc, Annotations anno)
ParsedPattern	endGrammar(Location loc, Annotations anno)
ParsedPattern	endIncludedGrammar(Location loc, Annotations anno)
private RefPattern	lookup(java.lang.String name)
private RefPattern	lookup1(java.lang.String name)
Div	makeDiv() Called when <div> is found.
Include	makeInclude() Returns null if already in an include.
ParsedPattern	makeParentRef(java.lang.String name, Location loc, Annotations anno)
ParsedPattern	makeRef(java.lang.String name, Location loc, Annotations anno)
void	topLevelAnnotation(ParsedElementAnnotation ea) Called when an annotation is found.
void	topLevelComment(CommentList comments) Called when a comment is found.

Methods inherited from class java.lang.Object

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

Field Detail

sb

private final SchemaBuilderImpl sb

defines

private final java.util.Hashtable defines

startRef

private final RefPattern startRef

parent

private final Scope parent

Constructor Detail

GrammarImpl

private GrammarImpl(SchemaBuilderImpl sb,
                    Scope parent)

GrammarImpl

protected GrammarImpl(SchemaBuilderImpl sb,
                      SchemaBuilderImpl.GrammarImpl g)

Method Detail

endGrammar

public ParsedPattern endGrammar(Location loc,
                                Annotations anno)
                         throws BuildException

Specified by:

endGrammar in interface Grammar

Throws:

BuildException

endDiv

public void endDiv(Location loc,
                   Annotations anno)
            throws BuildException

Specified by:

endDiv in interface Div

Throws:

BuildException

endIncludedGrammar

public ParsedPattern endIncludedGrammar(Location loc,
                                        Annotations anno)
                                 throws BuildException

Specified by:

endIncludedGrammar in interface IncludedGrammar

Returns:

technically, an included gramamr does not produce a pattern, but this allows Parseable.parseInclude(String, SchemaBuilder, IncludedGrammar, String) to return the result from IncludedGrammar nicely.

The value returned from this method will be returned from the abovementioned method.

Throws:

BuildException

define

public void define(java.lang.String name,
                   GrammarSection.Combine combine,
                   ParsedPattern pattern,
                   Location loc,
                   Annotations anno)
            throws BuildException

Description copied from interface: GrammarSection

Called when a pattern is defined.

Specified by:

define in interface GrammarSection

Parameters:

name - Name of the pattern. For the definition by a <start/> element, this parameter is the same as GrammarSection.START. to test if it's a named pattern definition or the start pattern definition.

combine - null or GrammarSection.COMBINE_CHOICE or GrammarSection.COMBINE_INTERLEAVE depending on the value of the combine attribute.

pattern - The pattern to be defined.

Throws:

BuildException

define

private void define(RefPattern rp,
                    GrammarSection.Combine combine,
                    ParsedPattern pattern,
                    Location loc)
             throws BuildException

Throws:

BuildException

topLevelAnnotation

public void topLevelAnnotation(ParsedElementAnnotation ea)
                        throws BuildException

Description copied from interface: GrammarSection

Called when an annotation is found.

Specified by:

topLevelAnnotation in interface GrammarSection

Throws:

BuildException

topLevelComment

public void topLevelComment(CommentList comments)
                     throws BuildException

Description copied from interface: GrammarSection

Called when a comment is found.

Specified by:

topLevelComment in interface GrammarSection

Throws:

BuildException

lookup

private RefPattern lookup(java.lang.String name)

lookup1

private RefPattern lookup1(java.lang.String name)

makeRef

public ParsedPattern makeRef(java.lang.String name,
                             Location loc,
                             Annotations anno)
                      throws BuildException

Specified by:

makeRef in interface Scope

Throws:

BuildException

makeParentRef

public ParsedPattern makeParentRef(java.lang.String name,
                                   Location loc,
                                   Annotations anno)
                            throws BuildException

Specified by:

makeParentRef in interface Scope

Throws:

BuildException

makeDiv

public Div makeDiv()

Description copied from interface: GrammarSection

Called when <div> is found.

Specified by:

makeDiv in interface GrammarSection

Returns:

the returned Div object will receive callbacks for structures inside the <div> element.

makeInclude

public Include makeInclude()

Description copied from interface: GrammarSection

Returns null if already in an include.

Specified by:

makeInclude in interface GrammarSection