Module io.virtdata.annotations
Package io.virtdata.autodoctypes

Class DocForFuncCtor

  • All Implemented Interfaces:
    DocCtorData
    public class DocForFuncCtor
extends java.lang.Object
implements DocCtorData

    • Constructor Summary

      Constructors 
      Constructor Description
      DocForFuncCtor​(java.lang.String className, java.lang.String ctorDoc, java.util.Map<java.lang.String,​java.lang.String> args, java.util.List<java.util.List<java.lang.String>> examples)  

    • 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()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DocForFuncCtor

        public DocForFuncCtor​(java.lang.String className,
                      java.lang.String ctorDoc,
                      java.util.Map<java.lang.String,​java.lang.String> args,
                      java.util.List<java.util.List<java.lang.String>> examples)

    • Method Detail

      • getClassName

        public java.lang.String getClassName()
        Specified by:
        getClassName in interface DocCtorData
        Returns:
        the Class.getSimpleName() of the documented ctor.

      • getCtorJavaDoc

        public java.lang.String getCtorJavaDoc()
        Specified by:
        getCtorJavaDoc in interface DocCtorData
        Returns:
        javadoc for the documented ctor, or null if it isn't provided

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getArgs

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

      • getExamples

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