Package uk.co.terminological.rjava.plugin

Class RMethod

java.lang.Object

uk.co.terminological.rjava.plugin.RAnnotated

uk.co.terminological.rjava.plugin.RMethod

public class RMethod
extends RAnnotated

Field Summary

Fields inherited from class uk.co.terminological.rjava.plugin.RAnnotated

simpleName, type

Constructor Summary

Constructors

Constructor	Description
RMethod(RModel model, RClass definingClass, Map<String,Object> annotations, String mname, String description, boolean isStatic, boolean isConstructor, boolean async, boolean future)

Method Summary

Modifier and Type	Method	Description
void	addParameter(String name, RType parameterType, String defaultExpr)
String	getDescription()
List<String>	getExamples()
String	getFunctionParameterCsv()
String	getFunctionParameterCsv(String sep)
String	getName()
String	getNonTitleDescription()
String	getParameterCsv()
String	getParameterCsv(String sep)
String	getParameterDescription(String paramName)
List<String>	getParameterNames()
RType	getParameterType(String paramName)
List<RType>	getParameterTypes()
String	getPrefixedParameterCsv(String pre)
String	getPrefixedParameterCsv(String pre, int tabs)
RType	getReturnType()
String	getSnakeCaseName()
List<String>	getTests()
String	getTitle()
boolean	hasExamples()
boolean	hasTests()
boolean	isAsync()
boolean	isConstructor()
boolean	isFactory()
boolean	isFuture()
boolean	isStatic()
void	setReturnType(RType returnType)

Methods inherited from class uk.co.terminological.rjava.plugin.RAnnotated

doxygen, doxygen, doxygen, doxygen, equals, getAnnotationList, getAnnotations, getAnnotationValue, getCanonicalName, getJNIName, getModel, getSimpleName, getSnakeCase, hashCode, indent, isA, mergeAnnotations, rdEscape, rdEscapeExample

Methods inherited from class java.lang.Object

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

Constructor Details

RMethod

public RMethod(RModel model,
 RClass definingClass,
 Map<String,Object> annotations,
 String mname,
 String description,
 boolean isStatic,
 boolean isConstructor,
 boolean async,
 boolean future)

Method Details

setReturnType

public void setReturnType(RType returnType)

addParameter

public void addParameter(String name,
 RType parameterType,
 String defaultExpr)

getSnakeCaseName

public String getSnakeCaseName()

Overrides:

getSnakeCaseName in class RAnnotated

getReturnType

public RType getReturnType()

getName

public String getName()

getParameterNames

public List<String> getParameterNames()

getParameterTypes

public List<RType> getParameterTypes()

isFactory

public boolean isFactory()

getDescription

public String getDescription()

getTitle

public String getTitle()

getNonTitleDescription

public String getNonTitleDescription()

getParameterDescription

public String getParameterDescription(String paramName)

getParameterType

public RType getParameterType(String paramName)

isStatic

public boolean isStatic()

isAsync

public boolean isAsync()

isFuture

public boolean isFuture()

hasExamples

public boolean hasExamples()

hasTests

public boolean hasTests()

getExamples

public List<String> getExamples()

getTests

public List<String> getTests()

isConstructor

public boolean isConstructor()

getParameterCsv

public String getParameterCsv()

getParameterCsv

public String getParameterCsv(String sep)

getPrefixedParameterCsv

public String getPrefixedParameterCsv(String pre)

getPrefixedParameterCsv

public String getPrefixedParameterCsv(String pre,
 int tabs)

getFunctionParameterCsv

public String getFunctionParameterCsv()

getFunctionParameterCsv

public String getFunctionParameterCsv(String sep)