Package eu.bandm.tools.option

Class Compiler.Phase_usage_enumerations

java.lang.Object

eu.bandm.tools.tdom.runtime.BaseVisitor

eu.bandm.tools.option.absy.Visitor

eu.bandm.tools.option.Compiler.Phase

eu.bandm.tools.option.Compiler.Phase_usage

eu.bandm.tools.option.Compiler.Phase_usage_enumerations

All Implemented Interfaces:

PCDataVisitor

Enclosing class:

Compiler

protected class Compiler.Phase_usage_enumerations
extends Compiler.Phase_usage

Deliver the documentation text table for all enumeration types. This is the doc text for each enum type, plus the list of all enum values, possibly with own doc texts.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Opt String	enumItem	For generating error messages.
(package private) String	enumname	For generating error messages.
(package private) boolean	first	Flag to output an empty line before all Enumeration descriptions but the first.

Fields inherited from class eu.bandm.tools.option.Compiler.Phase_usage

besttext, defaultLanguage, gm, langhit, textfound, usage_lang

Fields inherited from class eu.bandm.tools.option.Compiler.Phase

abbrev, currentOptionElement, name, option_qualifier

Fields inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

validating

Constructor Summary

Constructors

Constructor	Description
Phase_usage_enumerations(@Opt GeneratedMethod gm, String usage_lang, String defaultLanguage)	Evident

Method Summary

Modifier and Type	Method	Description
void	visit(Element_comment element)	Do nothing and DO NOT descend!
void	visit(Element_enumeration element)	Appends the usage() text of this enumeration definition to the global buffer by calling Compiler.Phase_usage.deliver(String)
void	visit(Element_option element)	Do nothing and DO NOT descend!
protected void	WARNING(Location<XMLDocumentIdentifier> loc, String text, Object... args)	Send warning to central message receiver Compiler.msgr after adding the name of the current option as the context info of the warning.

Methods inherited from class eu.bandm.tools.option.Compiler.Phase_usage

deliver, resetTextFound, visit, visit

Methods inherited from class eu.bandm.tools.option.Compiler.Phase

bothtags, bothtags_formatted, ERROR, longestname, longesttag, shortestname, shortesttag, WARNING

Methods inherited from class eu.bandm.tools.option.absy.Visitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

visit

Methods inherited from class java.lang.Object

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

Field Details

first

boolean first

Flag to output an empty line before all Enumeration descriptions but the first.

enumname

String enumname

For generating error messages.

enumItem

@Opt
@Opt String enumItem

For generating error messages.

Constructor Details

Phase_usage_enumerations

Phase_usage_enumerations(@Opt
 @Opt GeneratedMethod gm,
 String usage_lang,
 String defaultLanguage)

Evident

Method Details

WARNING

protected void WARNING(Location<XMLDocumentIdentifier> loc,
 String text,
 Object... args)

Description copied from class: Compiler.Phase

Send warning to central message receiver Compiler.msgr after adding the name of the current option as the context info of the warning.

This text manipulaton is NOT COMPATIBLE with translation, but assume that this programming tool is operatored only in the "lingua franca = English.

Overrides:

WARNING in class Compiler.Phase

visit

public void visit(Element_comment element)

Do nothing and DO NOT descend!

Overrides:

visit in class Visitor

visit

public void visit(Element_option element)

Do nothing and DO NOT descend!

Overrides:

visit in class Compiler.Phase

visit

public void visit(Element_enumeration element)

Appends the usage() text of this enumeration definition to the global buffer by calling Compiler.Phase_usage.deliver(String)

Overrides:

visit in class Visitor