Package io.nosqlbench.virtdata.api.processors

Class DocForFunc

java.lang.Object
io.nosqlbench.virtdata.api.processors.DocForFunc
All Implemented Interfaces:
DocFuncData
public class DocForFunc
extends java.lang.Object
implements DocFuncData

  • Constructor Summary

    Constructors 
    Constructor Description
    DocForFunc()  

  • Method Summary

    Modifier and Type Method Description
    void addCategories​(Category[] categories)  
    void addCtor​(java.lang.String ctorDoc, java.util.LinkedHashMap<java.lang.String,​java.lang.String> args, java.util.List<java.util.List<java.lang.String>> examples)  
    Category[] getCategories()  
    java.lang.String getClassJavadoc()
    Javadoc for the class, or null if there is none.
    java.lang.String getClassName()  
    java.util.ArrayList<DocCtorData> getCtors()
    The list of constructors for this documented type.
    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()  
    void setClassJavadoc​(java.lang.String classJavadoc)  
    void setClassName​(java.lang.String className)  
    void setInType​(java.lang.String inType)  
    void setOutType​(java.lang.String outType)  
    void setPackageName​(java.lang.String packageName)  
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • setPackageName

      public void setPackageName​(java.lang.String packageName)

    • 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.

    • setClassName

      public void setClassName​(java.lang.String className)

    • getClassName

      public java.lang.String getClassName()
      Specified by:
      getClassName in interface DocFuncData
      Returns:
      the the Class.getSimpleName() of the class element

    • setClassJavadoc

      public void setClassJavadoc​(java.lang.String classJavadoc)

    • 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

    • setInType

      public void setInType​(java.lang.String inType)

    • 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

    • setOutType

      public void setOutType​(java.lang.String outType)

    • 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

    • addCtor

      public void addCtor​(java.lang.String ctorDoc, java.util.LinkedHashMap<java.lang.String,​java.lang.String> args, java.util.List<java.util.List<java.lang.String>> examples)

    • getCtors

      public java.util.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 java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • addCategories

      public void addCategories​(Category[] categories)