Class Param
- java.lang.Object
-
- ch.colabproject.colab.generator.plugin.rest.Param
-
public class Param extends Object
represent a REST method parameter- Author:
- maxence
-
-
Constructor Summary
Constructors Constructor Description Param()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetInAnnotationName()Get @PathParam nameStringgetJavadoc()Get the value of javadocStringgetName()Get the value of nameTypegetType()Get the value of typebooleanisOptional()Is the parameter optional?voidsetInAnnotationName(String inAnnotationName)Set the path param namevoidsetJavadoc(String javadoc)Set the value of javadocvoidsetName(String name)Set the value of namevoidsetOptional(boolean optional)Set parameter optional-nessvoidsetType(Type type)Set the value of type
-
-
-
Method Detail
-
getType
public Type getType()
Get the value of type- Returns:
- the value of type
-
setType
public void setType(Type type)
Set the value of type- Parameters:
type- new value of type
-
getName
public String getName()
Get the value of name- Returns:
- the value of name
-
setName
public void setName(String name)
Set the value of name- Parameters:
name- new value of name
-
getInAnnotationName
public String getInAnnotationName()
Get @PathParam name- Returns:
- path param name
-
setInAnnotationName
public void setInAnnotationName(String inAnnotationName)
Set the path param name- Parameters:
inAnnotationName- new path param name
-
getJavadoc
public String getJavadoc()
Get the value of javadoc- Returns:
- the value of javadoc
-
setJavadoc
public void setJavadoc(String javadoc)
Set the value of javadoc- Parameters:
javadoc- new value of javadoc
-
isOptional
public boolean isOptional()
Is the parameter optional?- Returns:
- is optional or mandatory
-
setOptional
public void setOptional(boolean optional)
Set parameter optional-ness- Parameters:
optional- new optional value
-
-