Top Description Inners Fields Constructors Methods

org.antlr.stringtemplate

public Class StringTemplateGroupInterface

Class Inheritance

extends Object

java.lang.Object
org.antlr.stringtemplate.StringTemplateGroupInterface

Imports

org.antlr.stringtemplate.language.*, java.util.*, java.io.Reader

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);

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	StringTemplateGroupInterface.TemplateDefinition All the info we need to track for a template defined in an interface

Field Summary

Modifier and Type	Field and Description
public 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?
protected Map<K, V>	templates Maps template name to TemplateDefinition object

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public void	defineTemplate(String name, LinkedHashMap<K, V> formalArgs, boolean optional)
public void	error(String msg)
public void	error(String msg, Exception e)
public List<E>	getMismatchedTemplates(StringTemplateGroup group) Return a list of all template sigs that are present in the group, but that have wrong formal argument lists.
public List<E>	getMissingTemplates(StringTemplateGroup group) Return a list of all template names missing from group that are defined in this interface.
public String	getName()
public StringTemplateGroupInterface	getSuperInterface()
protected String	getTemplateSignature(StringTemplateGroupInterface.TemplateDefinition d)
protected void	parseInterface(Reader r)
public void	setName(String name)
public void	setSuperInterface(StringTemplateGroupInterface superInterface)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

DEFAULT_ERROR_LISTENER	back to summary
public static StringTemplateErrorListener DEFAULT_ERROR_LISTENER

listener	back to summary
protected StringTemplateErrorListener listener Where to report errors. All string templates in this group use this error handler by default.

name	back to summary
protected String name What is the group name

superInterface	back to summary
protected StringTemplateGroupInterface superInterface Are we derived from another group? Templates not found in this group will be searched for in the superGroup recursively.

templates	back to summary
protected Map<K, V> templates Maps template name to TemplateDefinition object

Constructor Detail

StringTemplateGroupInterface	back to summary
public StringTemplateGroupInterface(Reader r)

StringTemplateGroupInterface	back to summary
public StringTemplateGroupInterface(Reader r, StringTemplateErrorListener errors)

StringTemplateGroupInterface	back to summary
public StringTemplateGroupInterface(Reader r, StringTemplateErrorListener errors, StringTemplateGroupInterface superInterface) Create an interface from the input stream

Method Detail

defineTemplate	back to summary
public void defineTemplate(String name, LinkedHashMap<K, V> formalArgs, boolean optional)

error	back to summary
public void error(String msg)

error	back to summary
public void error(String msg, Exception e)

getMismatchedTemplates	back to summary
public List<E> 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.

getMissingTemplates	back to summary
public List<E> 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.

getName	back to summary
public String getName()

getSuperInterface	back to summary
public StringTemplateGroupInterface getSuperInterface()

getTemplateSignature	back to summary
protected String getTemplateSignature(StringTemplateGroupInterface.TemplateDefinition d)

parseInterface	back to summary
protected void parseInterface(Reader r)

setName	back to summary
public void setName(String name)

setSuperInterface	back to summary
public void setSuperInterface(StringTemplateGroupInterface superInterface)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

org.antlr.stringtemplate back to summary

pack-priv Class StringTemplateGroupInterface.TemplateDefinition

Class Inheritance

extends Object

java.lang.Object
org.antlr.stringtemplate.StringTemplateGroupInterface.TemplateDefinition

All the info we need to track for a template defined in an interface

Field Summary

Modifier and Type	Field and Description
public LinkedHashMap<K, V>	formalArgs
public String	name
public boolean	optional

Constructor Summary

Access	Constructor and Description
public	TemplateDefinition(String name, LinkedHashMap<K, V> formalArgs, boolean optional)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

formalArgs	back to summary
public LinkedHashMap<K, V> formalArgs

name	back to summary
public String name

optional	back to summary
public boolean optional

Constructor Detail

TemplateDefinition	back to summary
public TemplateDefinition(String name, LinkedHashMap<K, V> formalArgs, boolean optional)