Package io.nosqlbench.virtdata.api.processors

Interface DocCtorData

All Known Implementing Classes:
DocForFuncCtor
public interface DocCtorData

  • Method Summary

    Modifier and Type Method Description
    java.util.Map<java.lang.String,​java.lang.String> getArgs()  
    java.lang.String getClassName()  
    java.lang.String getCtorJavaDoc()  
    java.util.List<java.util.List<java.lang.String>> getExamples()  

  • Method Details

    • getClassName

      java.lang.String getClassName()
      Returns:
      the Class.getSimpleName() of the documented ctor.

    • getCtorJavaDoc

      java.lang.String getCtorJavaDoc()
      Returns:
      javadoc for the documented ctor, or null if it isn't provided

    • getArgs

      java.util.Map<java.lang.String,​java.lang.String> getArgs()
      Returns:
      an ordered map of the arguments of the documented constructor in name,type form.

    • getExamples

      java.util.List<java.util.List<java.lang.String>> getExamples()
      Returns:
      a list of examples, where each is list of (example syntax, comment..)