com.sun.tools.txw2.model

Class Define

java.lang.Object

com.sun.tools.txw2.model.Leaf

com.sun.tools.txw2.model.Node

com.sun.tools.txw2.model.WriterNode

com.sun.tools.txw2.model.Define

All Implemented Interfaces:

java.lang.Iterable<Leaf>, org.kohsuke.rngom.ast.om.ParsedPattern

Direct Known Subclasses:

Grammar

public class Define
extends WriterNode

A named pattern.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) com.sun.codemodel.JDefinedClass	clazz
java.lang.String	name
Grammar	scope

Fields inherited from class com.sun.tools.txw2.model.WriterNode

alternativeName

Fields inherited from class com.sun.tools.txw2.model.Node

leaf

Fields inherited from class com.sun.tools.txw2.model.Leaf

location

Constructor Summary

Constructors

Constructor and Description
Define(Grammar scope, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
(package private) void	declare(NodeSet nset) Declares the class without its contents.
(package private) void	generate(com.sun.codemodel.JDefinedClass clazz, NodeSet nset, java.util.Set<Prop> props) Populate the body of the writer class.
(package private) void	generate(NodeSet nset) Generates the contents.
boolean	isInline() Returns true if this define only contains one child (and thus considered inlinable.) A pattern definition is also inlineable if it's the start of the grammar (because "start" isn't a meaningful name)
(package private) void	prepare(NodeSet nset) Prepares for the code generation.
java.lang.String	toString()

Methods inherited from class com.sun.tools.txw2.model.Node

addChild, hasOneChild, iterator

Methods inherited from class com.sun.tools.txw2.model.Leaf

createDataMethod, getNext, getPrev, merge, siblings

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

scope

public final Grammar scope

name

public final java.lang.String name

clazz

com.sun.codemodel.JDefinedClass clazz

Constructor Detail

Define

public Define(Grammar scope,
              java.lang.String name)

Method Detail

isInline

public boolean isInline()

Returns true if this define only contains one child (and thus considered inlinable.) A pattern definition is also inlineable if it's the start of the grammar (because "start" isn't a meaningful name)

declare

void declare(NodeSet nset)

Description copied from class: WriterNode

Declares the class without its contents. The first step of the code generation.

Specified by:

declare in class WriterNode

generate

void generate(NodeSet nset)

Description copied from class: WriterNode

Generates the contents.

Specified by:

generate in class WriterNode

generate

void generate(com.sun.codemodel.JDefinedClass clazz,
              NodeSet nset,
              java.util.Set<Prop> props)

Description copied from class: Leaf

Populate the body of the writer class.

Specified by:

generate in class Leaf

props - captures the generatesd Props to

prepare

void prepare(NodeSet nset)

Description copied from class: WriterNode

Prepares for the code generation.

Overrides:

prepare in class WriterNode

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object