io.virtdata.processors

Class DocForFuncCtor

java.lang.Object

io.virtdata.processors.DocForFuncCtor

All Implemented Interfaces:

DocCtorData

public class DocForFuncCtor
extends Object
implements DocCtorData

Constructor Summary

Constructors

Constructor and Description
DocForFuncCtor(String className, String ctorDoc, Map<String,String> args, List<List<String>> examples)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getArgs()
String	getClassName()
String	getCtorJavaDoc()
List<List<String>>	getExamples()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocForFuncCtor

public DocForFuncCtor(String className,
                      String ctorDoc,
                      Map<String,String> args,
                      List<List<String>> examples)

Method Detail

getClassName

public String getClassName()

Specified by:

getClassName in interface DocCtorData

Returns:

the Class.getSimpleName() of the documented ctor.

getCtorJavaDoc

public String getCtorJavaDoc()

Specified by:

getCtorJavaDoc in interface DocCtorData

Returns:

javadoc for the documented ctor, or null if it isn't provided

toString

public String toString()

Overrides:

toString in class Object

getArgs

public Map<String,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 List<List<String>> getExamples()

Specified by:

getExamples in interface DocCtorData

Returns:

a list of examples, where each is list of (example syntax, comment..)