Package org.apache.tiles.autotag.model
Class TemplateParameter
java.lang.Object
org.apache.tiles.autotag.model.TemplateParameter
It represents a parameter in a method in a parsed template class.
- 
Constructor SummaryConstructorsConstructorDescriptionTemplateParameter(String name, String exportedName, String type, String defaultValue, boolean required, boolean request) Constructor.
- 
Method SummaryModifier and TypeMethodDescriptionReturns the default value, as it will be written in Java code.Returns the documentation for this parameter.Returns the exported name, i.e.Returns the suffix for getter and setter of the property generated by this parameter.getName()Returns the name of the parameter.getType()Returns the type of the parameter.booleanisBody()Indicates that this parameter implementsModelBody.booleanIndicates that this parameter implementsRequest.booleanIndicates that this parameter is required.voidsetDocumentation(String documentation) Sets the documentation for this parameter.toString()
- 
Constructor Details- 
TemplateParameterpublic TemplateParameter(String name, String exportedName, String type, String defaultValue, boolean required, boolean request) Constructor.- Parameters:
- name- The name of the parameter.
- exportedName- The exported name, i.e. the name of the parameter in created code. Usually helpful if this exported name is a reserved word.
- type- The type of the parameter.
- defaultValue- The default value, as it will be written in Java code.
- required- Indicates that this parameter is required.
 
 
- 
- 
Method Details- 
getDocumentationReturns the documentation for this parameter.- Returns:
- The documentation.
 
- 
setDocumentationSets the documentation for this parameter.- Parameters:
- documentation- The documentation.
 
- 
getNameReturns the name of the parameter.- Returns:
- The name of the parameter.
 
- 
getExportedNameReturns the exported name, i.e. the name of the parameter in created code. Usually helpful if this exported name is a reserved word.- Returns:
- The exported name.
 
- 
getTypeReturns the type of the parameter.- Returns:
- The type.
 
- 
getDefaultValueReturns the default value, as it will be written in Java code.- Returns:
- The default value.
 
- 
isRequiredpublic boolean isRequired()Indicates that this parameter is required.- Returns:
- trueif the parameter is required.
 
- 
isBodypublic boolean isBody()Indicates that this parameter implementsModelBody.- Returns:
- trueif the parameter is a body.
 
- 
isRequestpublic boolean isRequest()Indicates that this parameter implementsRequest.- Returns:
- trueif the parameter is a request.
 
- 
getGetterSetterSuffixReturns the suffix for getter and setter of the property generated by this parameter.- Returns:
- The getter and setter suffix.
 
- 
toString
 
-