Package org.jdrupes.mdoclet.internal.doclets.toolkit.builders

Klasse MemberSummaryBuilder

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.MemberSummaryBuilder
public abstract class MemberSummaryBuilder extends AbstractMemberBuilder
Builds the member summary.

There are two anonymous subtype variants of this builder, created in the getInstance(org.jdrupes.mdoclet.internal.doclets.toolkit.ClassWriter, org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder.Context) methods. One is for general types; the other is for annotation types.

  • Methodendetails

    • getInstance

      public static MemberSummaryBuilder getInstance(ClassWriter classWriter, AbstractBuilder.Context context)
      Construct a new MemberSummaryBuilder for a general type.
      Parameter:
      classWriter - the writer for the class whose members are being summarized.
      context - the build context.
      Gibt zurück:
      the instance

    • getVisibleMemberTable

      public VisibleMemberTable getVisibleMemberTable()
      Return the specified visible member map.
      Gibt zurück:
      the specified visible member map.
      Löst aus:
      ArrayIndexOutOfBoundsException - when the type is invalid.
      Siehe auch:

    • getMemberSummaryWriter

      public MemberSummaryWriter getMemberSummaryWriter(VisibleMemberTable.Kind kind)
      .

      Return the specified member summary writer.

      Parameter:
      kind - the kind of member summary writer to return.
      Gibt zurück:
      the specified member summary writer.
      Löst aus:
      ArrayIndexOutOfBoundsException - when the type is invalid.
      Siehe auch:

    • members

      public SortedSet<Element> members(VisibleMemberTable.Kind kind)
      Returns a list of methods that will be documented for the given class.

      This information can be used for doclet specific documentation generation.

      Parameter:
      kind - the kind of elements to return.
      Gibt zurück:
      a list of methods that will be documented.
      Siehe auch:

    • buildAnnotationTypeOptionalMemberSummary

      protected void buildAnnotationTypeOptionalMemberSummary(Content summariesList)
      Builds the summary for any optional members of an annotation type.
      Parameter:
      summariesList - the list of summaries to which the summary will be added

    • buildAnnotationTypeRequiredMemberSummary

      protected void buildAnnotationTypeRequiredMemberSummary(Content summariesList)
      Builds the summary for any required members of an annotation type.
      Parameter:
      summariesList - the list of summaries to which the summary will be added

    • buildEnumConstantsSummary

      protected void buildEnumConstantsSummary(Content summariesList)
      Builds the summary for any enum constants of an enum type.
      Parameter:
      summariesList - the list of summaries to which the summary will be added

    • buildFieldsSummary

      protected void buildFieldsSummary(Content summariesList)
      Builds the summary for any fields.
      Parameter:
      summariesList - the list of summaries to which the summary will be added

    • buildPropertiesSummary

      protected void buildPropertiesSummary(Content summariesList)
      Builds the summary for any properties.
      Parameter:
      summariesList - the list of summaries to which the summary will be added

    • buildNestedClassesSummary

      protected void buildNestedClassesSummary(Content summariesList)
      Builds the summary for any nested classes.
      Parameter:
      summariesList - the list of summaries to which the summary will be added

    • buildMethodsSummary

      protected void buildMethodsSummary(Content summariesList)
      Builds the summary for any methods.
      Parameter:
      summariesList - the content to which the documentation will be added

    • buildConstructorsSummary

      protected void buildConstructorsSummary(Content summariesList)
      Builds the summary for any constructors.
      Parameter:
      summariesList - the content to which the documentation will be added