Class DocForFunc

java.lang.Object

io.nosqlbench.virtdata.api.processors.DocForFunc

All Implemented Interfaces:

DocFuncData

public class DocForFunc
extends Object
implements DocFuncData

Constructor Summary

Constructors

Constructor	Description
DocForFunc()

Method Summary

Modifier and Type	Method	Description
void	addCategories(Category[] categories)
void	addCtor(String ctorDoc, LinkedHashMap<String,String> args, List<List<String>> examples)
Category[]	getCategories()
String	getClassJavadoc()	Javadoc for the class, or null if there is none.
String	getClassName()
ArrayList<DocCtorData>	getCtors()	The list of constructors for this documented type.
String	getInType()	The input type for the apply method in the documented function class.
String	getOutType()	The output type for the apply method in the documented function class.
String	getPackageName()
void	setClassJavadoc(String classJavadoc)
void	setClassName(String className)
void	setInType(String inType)
void	setOutType(String outType)
void	setPackageName(String packageName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DocForFunc

public DocForFunc()

Method Details

setPackageName

public void setPackageName(String packageName)

getPackageName

public String getPackageName()

Specified by:

getPackageName in interface DocFuncData

Returns:

the package name for the documented type

getCategories

public Category[] getCategories()

Specified by:

getCategories in interface DocFuncData

Returns:

Return the categories for this function.

setClassName

public void setClassName(String className)

getClassName

public String getClassName()

Specified by:

getClassName in interface DocFuncData

Returns:

the the Class.getSimpleName() of the class element

setClassJavadoc

public void setClassJavadoc(String classJavadoc)

getClassJavadoc

public String getClassJavadoc()

Description copied from interface: DocFuncData

Javadoc for the class, or null if there is none.

Specified by:

getClassJavadoc in interface DocFuncData

Returns:

a String of class javadoc data, or null if none

setInType

public void setInType(String inType)

getInType

public String getInType()

Description copied from interface: DocFuncData

The input type for the apply method in the documented function class. Documented function classes must always implement a Java 8 functional interface.

Specified by:

getInType in interface DocFuncData

Returns:

the input type name

setOutType

public void setOutType(String outType)

getOutType

public String getOutType()

Description copied from interface: DocFuncData

The output type for the apply method in the documented function class. Documented function classes must always implement a Java 8 functional interface.

Specified by:

getOutType in interface DocFuncData

Returns:

the output type name

addCtor

public void addCtor(String ctorDoc,
 LinkedHashMap<String,String> args,
 List<List<String>> examples)

getCtors

public ArrayList<DocCtorData> getCtors()

Description copied from interface: DocFuncData

The list of constructors for this documented type.

Specified by:

getCtors in interface DocFuncData

Returns:

a list of constructor models

toString

public String toString()

Overrides:

toString in class Object

addCategories

public void addCategories(Category[] categories)