org.jamon.codegen

Class TemplateUnit

java.lang.Object

org.jamon.codegen.AbstractStatementBlock

org.jamon.codegen.AbstractUnit

org.jamon.codegen.TemplateUnit

All Implemented Interfaces:

Comparable<AbstractUnit>, InheritedUnit, StatementBlock, Unit

public class TemplateUnit
extends AbstractUnit
implements InheritedUnit

Constructor Summary

Constructors

Constructor and Description
TemplateUnit(String path, ParserErrorsImpl errors)

Method Summary

Modifier and Type	Method and Description
void	addAnnotationNode(AnnotationNode node)
void	addCallPath(String callPath)
void	addClassContent(ClassNode node)
void	addFragmentArg(FragmentArgument arg)
void	addGenericsParamNode(GenericsParamNode node)
void	addImport(ImportNode node)
void	addInterface(String interfase)
void	addOptionalArg(OptionalArgument arg)
void	addParentArg(ParentArgNode arg)
void	addRequiredArg(RequiredArgument arg)
void	addStaticImport(StaticImportNode node)
protected void	generateInterfaceSummary(StringBuilder buf)
Collection<String>	getAbstractMethodNames()
Iterable<AnnotationNode>	getAnnotations()
Collection<AbstractArgument>	getDeclaredArgs()
Collection<FragmentArgument>	getDeclaredFragmentArgs()
Collection<MethodUnit>	getDeclaredMethodUnits()
Collection<OptionalArgument>	getDeclaredOptionalArgs()
Collection<? extends RequiredArgument>	getDeclaredRenderArgs()
DefUnit	getDefUnit(String name)
Collection<DefUnit>	getDefUnits()
String	getEncoding()
List<FragmentArgument>	getFragmentArgs()
GenericParams	getGenericParams()
Collection<MethodUnit>	getImplementedMethodUnits()
int	getInheritanceDepth()
String	getJamonContextType()
MethodUnit	getMethodUnit(String name)
String	getOptionalArgDefault(OptionalArgument arg)
String	getParentPath()
Collection<RequiredArgument>	getParentRenderArgs()
String	getProxyParentClass()
TemplateDescription	getReplacedTemplateDescription() Get the description of the template this template is replacing, or null if it is not replacing a template
String	getReplacedTemplatePath() Get the path of the template which this template replaces, or null if it is not replacing a template.
String	getSignature() Get the signature hash for this template.
Collection<MethodUnit>	getSignatureMethodUnits()
Collection<OptionalArgument>	getSignatureOptionalArgs()
List<RequiredArgument>	getSignatureRequiredArgs()
Collection<String>	getTemplateDependencies()
Collection<AbstractArgument>	getVisibleArgs()
boolean	hasParentPath()
boolean	isOriginatingJamonContext()
boolean	isParent()
boolean	isReplaceable() Get whether this template can be replaced by another one.
boolean	isReplacing() Whether this template replaces another template.
void	makeDefUnit(String defName, org.jamon.api.Location location)
void	makeMethodUnit(String methodName, org.jamon.api.Location location, boolean isAbstract)
OverriddenMethodUnit	makeOverridenMethodUnit(String name, org.jamon.api.Location location)
void	printClassContent(CodeWriter writer)
void	printDeclaredRenderArgs(CodeWriter writer)
void	printDeclaredRenderArgsDecl(CodeWriter writer)
void	printImports(CodeWriter writer)
void	printInterfaces(CodeWriter writer)
void	printParentRenderArgs(CodeWriter writer)
void	printParentRenderArgsDecl(CodeWriter writer)
void	setEncoding(String encoding)
void	setIsParent()
void	setJamonContextType(String jamonContextType)
void	setParentDescription(TemplateDescription parent) public for unit testing purposes
void	setParentPath(String parentPath)
void	setReplaceable(boolean replaceable) Set whether this template can be replaced by another one.
void	setReplacedTemplatePathAndDescription(String replacedTemplatePath, TemplateDescription templateDescription) Set the path of the template which this template replaces, along with the description of the replaced template.

Methods inherited from class org.jamon.codegen.AbstractUnit

addArgName, addFragment, addOptionalArg, addRequiredArg, compareTo, generateRenderBody, getErrors, getFragmentUnitIntf, getName, getParentUnit, getRenderArgs, printArgs, printArgsDecl, printRenderArgs, printRenderArgsDecl

Methods inherited from class org.jamon.codegen.AbstractStatementBlock

addStatement, doesIO, getLocation, getParent, getStatements, printStatements

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jamon.codegen.Unit

doesIO

Methods inherited from interface org.jamon.codegen.StatementBlock

addStatement, getParent

Constructor Detail

TemplateUnit

public TemplateUnit(String path,
                    ParserErrorsImpl errors)

Method Detail

getInheritanceDepth

public int getInheritanceDepth()

setParentDescription

public void setParentDescription(TemplateDescription parent)

public for unit testing purposes

addParentArg

public void addParentArg(ParentArgNode arg)

Specified by:

addParentArg in interface InheritedUnit

getFragmentArgs

public List<FragmentArgument> getFragmentArgs()

Specified by:

getFragmentArgs in interface Unit

Specified by:

getFragmentArgs in class AbstractUnit

addFragmentArg

public void addFragmentArg(FragmentArgument arg)

Specified by:

addFragmentArg in class AbstractUnit

getDeclaredFragmentArgs

public Collection<FragmentArgument> getDeclaredFragmentArgs()

addRequiredArg

public void addRequiredArg(RequiredArgument arg)

Specified by:

addRequiredArg in class AbstractUnit

addOptionalArg

public void addOptionalArg(OptionalArgument arg)

Specified by:

addOptionalArg in class AbstractUnit

getSignatureRequiredArgs

public List<RequiredArgument> getSignatureRequiredArgs()

Specified by:

getSignatureRequiredArgs in interface Unit

Specified by:

getSignatureRequiredArgs in class AbstractUnit

getSignatureOptionalArgs

public Collection<OptionalArgument> getSignatureOptionalArgs()

Specified by:

getSignatureOptionalArgs in interface Unit

Specified by:

getSignatureOptionalArgs in class AbstractUnit

getOptionalArgDefault

public String getOptionalArgDefault(OptionalArgument arg)

getVisibleArgs

public Collection<AbstractArgument> getVisibleArgs()

Specified by:

getVisibleArgs in class AbstractUnit

getDeclaredOptionalArgs

public Collection<OptionalArgument> getDeclaredOptionalArgs()

getTemplateDependencies

public Collection<String> getTemplateDependencies()

makeDefUnit

public void makeDefUnit(String defName,
                        org.jamon.api.Location location)

getDefUnits

public Collection<DefUnit> getDefUnits()

getDefUnit

public DefUnit getDefUnit(String name)

makeMethodUnit

public void makeMethodUnit(String methodName,
                           org.jamon.api.Location location,
                           boolean isAbstract)

makeOverridenMethodUnit

public OverriddenMethodUnit makeOverridenMethodUnit(String name,
                                                    org.jamon.api.Location location)

getMethodUnit

public MethodUnit getMethodUnit(String name)

getSignatureMethodUnits

public Collection<MethodUnit> getSignatureMethodUnits()

getDeclaredMethodUnits

public Collection<MethodUnit> getDeclaredMethodUnits()

getImplementedMethodUnits

public Collection<MethodUnit> getImplementedMethodUnits()

getAbstractMethodNames

public Collection<String> getAbstractMethodNames()

addStaticImport

public void addStaticImport(StaticImportNode node)

addImport

public void addImport(ImportNode node)

addInterface

public void addInterface(String interfase)

setParentPath

public void setParentPath(String parentPath)

getParentPath

public String getParentPath()

hasParentPath

public boolean hasParentPath()

setReplacedTemplatePathAndDescription

public void setReplacedTemplatePathAndDescription(String replacedTemplatePath,
                                                  TemplateDescription templateDescription)

Set the path of the template which this template replaces, along with the description of the replaced template.

Parameters:

replacedTemplatePath - the path of the template which this template replaced

templateDescription - the description of the replaced template

getReplacedTemplatePath

public String getReplacedTemplatePath()

Get the path of the template which this template replaces, or null if it is not replacing a template.

Returns:

the path of the template which this template replaces, or null if it is not replacing a template.

getReplacedTemplateDescription

public TemplateDescription getReplacedTemplateDescription()

Get the description of the template this template is replacing, or null if it is not replacing a template

Returns:

the description of the template this template is replacing, or null if it is not replacing a template

isReplacing

public boolean isReplacing()

Whether this template replaces another template. This is the case if the template has a <%replacesTemplate ...> tag.

Returns:

true if this template replaces another template.

setReplaceable

public void setReplaceable(boolean replaceable)

Set whether this template can be replaced by another one.

Parameters:

replaceable - whether this template can be replaced by another one.

isReplaceable

public boolean isReplaceable()

Get whether this template can be replaced by another one.

Returns:

whether this template can be replaced by another one.

getProxyParentClass

public String getProxyParentClass()

isParent

public boolean isParent()

setIsParent

public void setIsParent()

printClassContent

public void printClassContent(CodeWriter writer)

addClassContent

public void addClassContent(ClassNode node)

addCallPath

public void addCallPath(String callPath)

getParentRenderArgs

public Collection<RequiredArgument> getParentRenderArgs()

printImports

public void printImports(CodeWriter writer)

printParentRenderArgs

public void printParentRenderArgs(CodeWriter writer)

printParentRenderArgsDecl

public void printParentRenderArgsDecl(CodeWriter writer)

getDeclaredRenderArgs

public Collection<? extends RequiredArgument> getDeclaredRenderArgs()

getDeclaredArgs

public Collection<AbstractArgument> getDeclaredArgs()

printDeclaredRenderArgs

public void printDeclaredRenderArgs(CodeWriter writer)

printDeclaredRenderArgsDecl

public void printDeclaredRenderArgsDecl(CodeWriter writer)

printInterfaces

public void printInterfaces(CodeWriter writer)

generateInterfaceSummary

protected void generateInterfaceSummary(StringBuilder buf)

Overrides:

generateInterfaceSummary in class AbstractUnit

getSignature

public String getSignature()

Get the signature hash for this template. The signature is a hash which will change in the event that the template's API has changed.

Returns:

the signature hash for this template

getGenericParams

public GenericParams getGenericParams()

setJamonContextType

public void setJamonContextType(String jamonContextType)

getJamonContextType

public String getJamonContextType()

isOriginatingJamonContext

public boolean isOriginatingJamonContext()

addGenericsParamNode

public void addGenericsParamNode(GenericsParamNode node)

addAnnotationNode

public void addAnnotationNode(AnnotationNode node)

getAnnotations

public Iterable<AnnotationNode> getAnnotations()

setEncoding

public void setEncoding(String encoding)

getEncoding

public String getEncoding()