public class TemplateParameter extends Object
Constructor and Description |
---|
TemplateParameter(String name,
String exportedName,
String type,
String defaultValue,
boolean required,
boolean request)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getDefaultValue()
Returns the default value, as it will be written in Java code.
|
String |
getDocumentation()
Returns the documentation for this parameter.
|
String |
getExportedName()
Returns the exported name, i.e.
|
String |
getGetterSetterSuffix()
Returns the suffix for getter and setter of the property generated by
this parameter.
|
String |
getName()
Returns the name of the parameter.
|
String |
getType()
Returns the type of the parameter.
|
boolean |
isBody()
Indicates that this parameter implements
ModelBody . |
boolean |
isRequest()
Indicates that this parameter implements
Request . |
boolean |
isRequired()
Indicates that this parameter is required.
|
void |
setDocumentation(String documentation)
Sets the documentation for this parameter.
|
String |
toString() |
public TemplateParameter(String name, String exportedName, String type, String defaultValue, boolean required, boolean request)
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.public String getDocumentation()
public void setDocumentation(String documentation)
documentation
- The documentation.public String getName()
public String getExportedName()
public String getType()
public String getDefaultValue()
public boolean isRequired()
true
if the parameter is required.public boolean isBody()
ModelBody
.true
if the parameter is a body.public boolean isRequest()
Request
.true
if the parameter is a request.public String getGetterSetterSuffix()
Copyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.