java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo
Direct Known Subclasses:
LinkInfoImpl

@Deprecated public abstract class LinkInfo extends Object
Deprecated.
Encapsulates information about a link.

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.

Since:
1.5
  • Field Details

    • classDoc

      public ClassDoc classDoc
      Deprecated.
      The ClassDoc we want to link to. Null if we are not linking to a ClassDoc.
    • executableMemberDoc

      public ExecutableMemberDoc executableMemberDoc
      Deprecated.
      The executable member doc we want to link to. Null if we are not linking to an executable member.
    • type

      public Type type
      Deprecated.
      The Type we want to link to. Null if we are not linking to a type.
    • isVarArg

      public boolean isVarArg
      Deprecated.
      True if this is a link to a VarArg.
    • isTypeBound

      public boolean isTypeBound
      Deprecated.
      Set this to true to indicate that you are linking to a type parameter.
    • isJava5DeclarationLocation

      public boolean isJava5DeclarationLocation
      Deprecated.
      Whether the document element is in a Java 5 declaration location or not.
    • label

      public Content label
      Deprecated.
      The label for the link.
    • isStrong

      public boolean isStrong
      Deprecated.
      True if the link should be strong.
    • includeTypeInClassLinkLabel

      public boolean includeTypeInClassLinkLabel
      Deprecated.
      True if we should include the type in the link label. False otherwise.
    • excludeTypeBounds

      public boolean excludeTypeBounds
      Deprecated.
      True if we should exclude the type bounds for the type parameter.
    • linkToSelf

      public boolean linkToSelf
      Deprecated.
      By default, the link can be to the page it's already on. However, there are cases where we don't want this (e.g. heading of class page).
  • Constructor Details

    • LinkInfo

      public LinkInfo()
      Deprecated.
  • Method Details

    • newContent

      protected abstract Content newContent()
      Deprecated.
      Return an empty instance of a content object.
      Returns:
      an empty instance of a content object.
    • isLinkable

      public abstract boolean isLinkable()
      Deprecated.
      Return true if this link is linkable and false if we can't link to the desired place.
      Returns:
      true if this link is linkable and false if we can't link to the desired place.
    • getClassLinkLabel

      public Content getClassLinkLabel(Configuration configuration)
      Deprecated.
      Return the label for this class link.
      Parameters:
      configuration - the current configuration of the doclet.
      Returns:
      the label for this class link.