org.kohsuke.rngom.digested

Class IncludeImpl.IncludedGrammarImpl

java.lang.Object

org.kohsuke.rngom.digested.GrammarBuilderImpl

org.kohsuke.rngom.digested.IncludeImpl.IncludedGrammarImpl

All Implemented Interfaces:

Div, Grammar, GrammarSection, IncludedGrammar, Scope

Enclosing class:

IncludeImpl

private class IncludeImpl.IncludedGrammarImpl
extends GrammarBuilderImpl
implements IncludedGrammar

Nested Class Summary

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

GrammarSection.Combine

Field Summary

Fields inherited from class org.kohsuke.rngom.digested.GrammarBuilderImpl

grammar, parent, sb

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

COMBINE_CHOICE, COMBINE_INTERLEAVE, START

Constructor Summary

Constructors

Constructor and Description
IncludedGrammarImpl(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.
ParsedPattern	endIncludedGrammar(Location loc, Annotations anno)

Methods inherited from class org.kohsuke.rngom.digested.GrammarBuilderImpl

endDiv, endGrammar, makeDiv, makeInclude, makeParentRef, makeRef, topLevelAnnotation, topLevelComment

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kohsuke.rngom.ast.builder.Scope

makeParentRef, makeRef

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

makeDiv, makeInclude, topLevelAnnotation, topLevelComment

Constructor Detail

IncludedGrammarImpl

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

Method Detail

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

Overrides:

define in class GrammarBuilderImpl

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

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