Class StringTemplateGroupInterface

java.lang.Object

org.antlr.stringtemplate.StringTemplateGroupInterface

public class StringTemplateGroupInterface
extends Object

A group interface is like a group without the template implementations; there are just template names/argument-lists like this: interface foo; class(name,fields); method(name,args,body);

Field Summary

Fields

Modifier and Type	Field	Description
static StringTemplateErrorListener	DEFAULT_ERROR_LISTENER
protected StringTemplateErrorListener	listener	Where to report errors.
protected String	name	What is the group name
protected StringTemplateGroupInterface	superInterface	Are we derived from another group? Templates not found in this group will be searched for in the superGroup recursively.
protected Map	templates	Maps template name to TemplateDefinition object

Constructor Summary

Constructors

Constructor	Description
StringTemplateGroupInterface(Reader r)
StringTemplateGroupInterface(Reader r, StringTemplateErrorListener errors)
StringTemplateGroupInterface(Reader r, StringTemplateErrorListener errors, StringTemplateGroupInterface superInterface)	Create an interface from the input stream

Method Summary

Modifier and Type	Method	Description
void	defineTemplate(String name, LinkedHashMap formalArgs, boolean optional)
void	error(String msg)
void	error(String msg, Exception e)
List	getMismatchedTemplates(StringTemplateGroup group)	Return a list of all template sigs that are present in the group, but that have wrong formal argument lists.
List	getMissingTemplates(StringTemplateGroup group)	Return a list of all template names missing from group that are defined in this interface.
String	getName()
StringTemplateGroupInterface	getSuperInterface()
protected String	getTemplateSignature(org.antlr.stringtemplate.StringTemplateGroupInterface.TemplateDefinition d)
protected void	parseInterface(Reader r)
void	setName(String name)
void	setSuperInterface(StringTemplateGroupInterface superInterface)
String	toString()

Methods inherited from class Object

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

Field Details

name

protected String name

What is the group name

templates

protected Map templates

Maps template name to TemplateDefinition object

superInterface

protected StringTemplateGroupInterface superInterface

Are we derived from another group? Templates not found in this group will be searched for in the superGroup recursively.

listener

protected StringTemplateErrorListener listener

Where to report errors. All string templates in this group use this error handler by default.

DEFAULT_ERROR_LISTENER

public static StringTemplateErrorListener DEFAULT_ERROR_LISTENER

Constructor Details

StringTemplateGroupInterface

public StringTemplateGroupInterface(Reader r)

StringTemplateGroupInterface

public StringTemplateGroupInterface(Reader r,
 StringTemplateErrorListener errors)

StringTemplateGroupInterface

public StringTemplateGroupInterface(Reader r,
 StringTemplateErrorListener errors,
 StringTemplateGroupInterface superInterface)

Create an interface from the input stream

Method Details

getSuperInterface

public StringTemplateGroupInterface getSuperInterface()

setSuperInterface

public void setSuperInterface(StringTemplateGroupInterface superInterface)

parseInterface

protected void parseInterface(Reader r)

defineTemplate

public void defineTemplate(String name,
 LinkedHashMap formalArgs,
 boolean optional)

getMissingTemplates

public List getMissingTemplates(StringTemplateGroup group)

Return a list of all template names missing from group that are defined in this interface. Return null if all is well.

getMismatchedTemplates

public List getMismatchedTemplates(StringTemplateGroup group)

Return a list of all template sigs that are present in the group, but that have wrong formal argument lists. Return null if all is well.

getName

public String getName()

setName

public void setName(String name)

error

public void error(String msg)

error

public void error(String msg,
 Exception e)

toString

public String toString()

Overrides:

toString in class Object

getTemplateSignature

protected String getTemplateSignature(org.antlr.stringtemplate.StringTemplateGroupInterface.TemplateDefinition d)