Class AbstractExecutableMemberWriter

  • Direct Known Subclasses:
    ConstructorWriterImpl, MethodWriterImpl

    @Deprecated
    public abstract class AbstractExecutableMemberWriter
    extends AbstractMemberWriter
    Deprecated.
    Print method and constructor info.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    Author:
    Robert Field, Atul M Dambalkar, Bhavesh Patel (Modified)
    • Constructor Detail

      • AbstractExecutableMemberWriter

        public AbstractExecutableMemberWriter​(SubWriterHolderWriter writer)
        Deprecated.
    • Method Detail

      • addTypeParameters

        protected void addTypeParameters​(ExecutableMemberDoc member,
                                         Content htmltree)
        Deprecated.
        Add the type parameters for the executable member.
        Parameters:
        member - the member to write type parameters for.
        htmltree - the content tree to which the parameters will be added.
      • getTypeParameters

        protected Content getTypeParameters​(ExecutableMemberDoc member)
        Deprecated.
        Get the type parameters for the executable member.
        Parameters:
        member - the member for which to get the type parameters.
        Returns:
        the type parameters.
      • addSummaryLink

        protected void addSummaryLink​(LinkInfoImpl.Kind context,
                                      ClassDoc cd,
                                      ProgramElementDoc member,
                                      Content tdSummary)
        Deprecated.
        Add the summary link for the member.
        Specified by:
        addSummaryLink in class AbstractMemberWriter
        Parameters:
        context - the id of the context where the link will be printed
        cd - the classDoc that we should link to
        member - the member being linked to
        tdSummary - the content tree to which the link will be added
      • addInheritedSummaryLink

        protected void addInheritedSummaryLink​(ClassDoc cd,
                                               ProgramElementDoc member,
                                               Content linksTree)
        Deprecated.
        Add the inherited summary link for the member.
        Specified by:
        addInheritedSummaryLink in class AbstractMemberWriter
        Parameters:
        cd - the classDoc that we should link to
        member - the member being linked to
        linksTree - the content tree to which the link will be added
      • addParam

        protected void addParam​(ExecutableMemberDoc member,
                                Parameter param,
                                boolean isVarArg,
                                Content tree)
        Deprecated.
        Add the parameter for the executable member.
        Parameters:
        member - the member to write parameter for.
        param - the parameter that needs to be written.
        isVarArg - true if this is a link to var arg.
        tree - the content tree to which the parameter information will be added.
      • addReceiverAnnotations

        protected void addReceiverAnnotations​(ExecutableMemberDoc member,
                                              Type rcvrType,
                                              AnnotationDesc[] descList,
                                              Content tree)
        Deprecated.
        Add the receiver annotations information.
        Parameters:
        member - the member to write receiver annotations for.
        rcvrType - the receiver type.
        descList - list of annotation description.
        tree - the content tree to which the information will be added.
      • addParameters

        protected void addParameters​(ExecutableMemberDoc member,
                                     Content htmltree,
                                     int indentSize)
        Deprecated.
        Add all the parameters for the executable member.
        Parameters:
        member - the member to write parameters for.
        htmltree - the content tree to which the parameters information will be added.
      • addParameters

        protected void addParameters​(ExecutableMemberDoc member,
                                     boolean includeAnnotations,
                                     Content htmltree,
                                     int indentSize)
        Deprecated.
        Add all the parameters for the executable member.
        Parameters:
        member - the member to write parameters for.
        includeAnnotations - true if annotation information needs to be added.
        htmltree - the content tree to which the parameters information will be added.
      • addExceptions

        protected void addExceptions​(ExecutableMemberDoc member,
                                     Content htmltree,
                                     int indentSize)
        Deprecated.
        Add exceptions for the executable member.
        Parameters:
        member - the member to write exceptions for.
        htmltree - the content tree to which the exceptions information will be added.
      • implementsMethodInIntfac

        protected ClassDoc implementsMethodInIntfac​(MethodDoc method,
                                                    ClassDoc[] intfacs)
        Deprecated.
      • getErasureAnchor

        protected String getErasureAnchor​(ExecutableMemberDoc emd)
        Deprecated.
        For backward compatibility, include an anchor using the erasures of the parameters. NOTE: We won't need this method anymore after we fix see tags so that they use the type instead of the erasure.
        Parameters:
        emd - the ExecutableMemberDoc to anchor to.
        Returns:
        the 1.4.x style anchor for the ExecutableMemberDoc.