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 Summary
ConstructorsConstructorDescriptionTemplateParameter
(String name, String exportedName, String type, String defaultValue, boolean required, boolean request) Constructor. -
Method Summary
Modifier 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.boolean
isBody()
Indicates that this parameter implementsModelBody
.boolean
Indicates that this parameter implementsRequest
.boolean
Indicates that this parameter is required.void
setDocumentation
(String documentation) Sets the documentation for this parameter.toString()
-
Constructor Details
-
TemplateParameter
public 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
-
getDocumentation
Returns the documentation for this parameter.- Returns:
- The documentation.
-
setDocumentation
Sets the documentation for this parameter.- Parameters:
documentation
- The documentation.
-
getName
Returns the name of the parameter.- Returns:
- The name of the parameter.
-
getExportedName
Returns 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.
-
getType
Returns the type of the parameter.- Returns:
- The type.
-
getDefaultValue
Returns the default value, as it will be written in Java code.- Returns:
- The default value.
-
isRequired
public boolean isRequired()Indicates that this parameter is required.- Returns:
true
if the parameter is required.
-
isBody
public boolean isBody()Indicates that this parameter implementsModelBody
.- Returns:
true
if the parameter is a body.
-
isRequest
public boolean isRequest()Indicates that this parameter implementsRequest
.- Returns:
true
if the parameter is a request.
-
getGetterSetterSuffix
Returns the suffix for getter and setter of the property generated by this parameter.- Returns:
- The getter and setter suffix.
-
toString
-