com.github.therapi.runtimejavadoc

Class ClassJavadoc

java.lang.Object

com.github.therapi.runtimejavadoc.BaseJavadoc

com.github.therapi.runtimejavadoc.ClassJavadoc

public class ClassJavadoc
extends BaseJavadoc

Constructor Summary

Constructors

Constructor and Description
ClassJavadoc(java.lang.String name, Comment comment, java.util.List<FieldJavadoc> fields, java.util.List<FieldJavadoc> enumConstants, java.util.List<MethodJavadoc> methods, java.util.List<MethodJavadoc> constructors, java.util.List<OtherJavadoc> other, java.util.List<SeeAlsoJavadoc> seeAlso, java.util.List<ParamJavadoc> recordComponents)

Method Summary

Modifier and Type	Method and Description
static ClassJavadoc	createEmpty(java.lang.String qualifiedClassName)
java.util.List<MethodJavadoc>	getConstructors()
java.util.List<FieldJavadoc>	getEnumConstants()
java.util.List<FieldJavadoc>	getFields()
java.util.List<MethodJavadoc>	getMethods()
java.util.List<ParamJavadoc>	getRecordComponents() If this class is a record, returns the "@param" tags from the canonical constructor.
java.lang.String	toString()

Methods inherited from class com.github.therapi.runtimejavadoc.BaseJavadoc

getComment, getName, getOther, getSeeAlso, isEmpty, isPresent

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassJavadoc

public ClassJavadoc(java.lang.String name,
                    Comment comment,
                    java.util.List<FieldJavadoc> fields,
                    java.util.List<FieldJavadoc> enumConstants,
                    java.util.List<MethodJavadoc> methods,
                    java.util.List<MethodJavadoc> constructors,
                    java.util.List<OtherJavadoc> other,
                    java.util.List<SeeAlsoJavadoc> seeAlso,
                    java.util.List<ParamJavadoc> recordComponents)

Method Detail

createEmpty

public static ClassJavadoc createEmpty(java.lang.String qualifiedClassName)

getFields

public java.util.List<FieldJavadoc> getFields()

getEnumConstants

public java.util.List<FieldJavadoc> getEnumConstants()

getMethods

public java.util.List<MethodJavadoc> getMethods()

getConstructors

public java.util.List<MethodJavadoc> getConstructors()

getRecordComponents

public java.util.List<ParamJavadoc> getRecordComponents()

If this class is a record, returns the "@param" tags from the canonical constructor. Otherwise, returns an empty list.

Returns:

a non-null (but possibly empty) list of param tags describing the record components, in the order the tags appear in the Javadoc.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object