jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/LinkInfo.java@9d9f26857129 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/LinkInfo.java@9d9f26857129 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/LinkInfo.java

Tue, 25 May 2010 15:54:51 -0700

author: ohair
date: Tue, 25 May 2010 15:54:51 -0700
changeset 554: 9d9f26857129
parent 182: 47a62d8d98b4
child 1359: 25e14ad23cef
permissions: -rw-r--r--

6943119: Rebrand source copyright notices
Reviewed-by: darcy

 /*
  * Copyright (c) 2003, 2005, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
 package com.sun.tools.doclets.internal.toolkit.util.links;
 import com.sun.javadoc.*;
 import com.sun.tools.doclets.internal.toolkit.Configuration;
 /**
  * Encapsulates information about a link.
  *
  * @author Jamie Ho
  * @since 1.5
  */
 public abstract class LinkInfo {
     /**
      * The ClassDoc we want to link to.  Null if we are not linking
      * to a ClassDoc.
      */
     public ClassDoc classDoc;
     /**
      * The executable member doc we want to link to.  Null if we are not linking
      * to an executable member.
      */
     public ExecutableMemberDoc executableMemberDoc;
     /**
      * The Type we want to link to.  Null if we are not linking to a type.
      */
     public Type type;
     /**
      * True if this is a link to a VarArg.
      */
     public boolean isVarArg = false;
     /**
      * Set this to true to indicate that you are linking to a type parameter.
      */
     public boolean isTypeBound = false;
     /**
      * The label for the link.
      */
     public String label;
     /**
      * True if the link should be strong.
      */
     public boolean isStrong = false;
     /**
      * True if we should include the type in the link label.  False otherwise.
      */
     public boolean includeTypeInClassLinkLabel = true;
     /**
      * True if we should include the type as seperate link.  False otherwise.
      */
     public boolean includeTypeAsSepLink = false;
     /**
      * True if we should exclude the type bounds for the type parameter.
      */
     public boolean excludeTypeBounds = false;
     /**
      * True if we should print the type parameters, but not link them.
      */
     public boolean excludeTypeParameterLinks = false;
     /**
      * True if we should print the type bounds, but not link them.
      */
     public boolean excludeTypeBoundsLinks = false;
     /**
      * 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).
      */
     public boolean linkToSelf = true;
     /**
      * The display length for the link.
      */
     public int displayLength = 0;
     /**
      * Return the id indicating where the link appears in the documentation.
      * This is used for special processing of different types of links.
      *
      * @return the id indicating where the link appears in the documentation.
      */
     public abstract int getContext();
     /**
      * Set the context.
      *
      * @param c the context id to set.
      */
     public abstract void setContext(int c);
     /**
      * Return true if this link is linkable and false if we can't link to the
      * desired place.
      *
      * @return true if this link is linkable and false if we can't link to the
      * desired place.
      */
     public abstract boolean isLinkable();
     /**
      * Return the label for this class link.
      *
      * @param configuration the current configuration of the doclet.
      * @return the label for this class link.
      */
     public String getClassLinkLabel(Configuration configuration) {
         if (label != null && label.length() > 0) {
             return label;
         } else if (isLinkable()) {
             return classDoc.name();
         } else {
             return configuration.getClassName(classDoc);
         }
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/LinkInfo.java@9d9f26857129 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/LinkInfo.java