Package io.virtdata.processors

Class ExampleDocData

java.lang.Object

io.virtdata.processors.ExampleDocData

All Implemented Interfaces:

DocFuncData

public class ExampleDocData
extends java.lang.Object
implements DocFuncData

Constructor Summary

Constructors

Constructor	Description
ExampleDocData()

Method Summary

Modifier and Type	Method	Description
Category[]	getCategories()
java.lang.String	getClassJavadoc()	Javadoc for the class, or null if there is none.
java.lang.String	getClassName()
java.util.List<DocCtorData>	getCtors()	The list of constructors for this documented type.
java.util.List<DocForFuncCtor>	getCtorsAlternate()
java.lang.String	getInType()	The input type for the apply method in the documented function class.
java.lang.String	getOutType()	The output type for the apply method in the documented function class.
java.lang.String	getPackageName()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleDocData

public ExampleDocData()

Method Detail

getPackageName

public java.lang.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.

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface DocFuncData

Returns:

the the Class.getSimpleName() of the class element

getClassJavadoc

public java.lang.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

getInType

public java.lang.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

getOutType

public java.lang.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

getCtors

public java.util.List<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

getCtorsAlternate

public java.util.List<DocForFuncCtor> getCtorsAlternate()