org.kohsuke.rngom.digested

Class GrammarBuilderImpl

java.lang.Object

org.kohsuke.rngom.digested.GrammarBuilderImpl

All Implemented Interfaces:

Div, Grammar, GrammarSection, Scope

Direct Known Subclasses:

IncludeImpl, IncludeImpl.IncludedGrammarImpl

class GrammarBuilderImpl
extends java.lang.Object
implements Grammar, Div

Nested Class Summary

Nested classes/interfaces inherited from interface org.kohsuke.rngom.ast.builder.GrammarSection

GrammarSection.Combine

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<org.w3c.dom.Element>	additionalElementAnnotations Additional top-level element annotations.
protected DGrammarPattern	grammar
protected Scope	parent
protected DSchemaBuilderImpl	sb

Fields inherited from interface org.kohsuke.rngom.ast.builder.GrammarSection

COMBINE_CHOICE, COMBINE_INTERLEAVE, START

Constructor Summary

Constructors

Constructor and Description
GrammarBuilderImpl(DGrammarPattern p, Scope parent, DSchemaBuilderImpl sb)

Method Summary

Modifier and Type	Method and Description
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)
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

grammar

protected final DGrammarPattern grammar

parent

protected final Scope parent

sb

protected final DSchemaBuilderImpl sb

additionalElementAnnotations

private java.util.List<org.w3c.dom.Element> additionalElementAnnotations

Additional top-level element annotations. Can be null.

Constructor Detail

GrammarBuilderImpl

public GrammarBuilderImpl(DGrammarPattern p,
                          Scope parent,
                          DSchemaBuilderImpl sb)

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

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

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

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

makeParentRef

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

Specified by:

makeParentRef in interface Scope

Throws:

BuildException

makeRef

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

Specified by:

makeRef in interface Scope

Throws:

BuildException