jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/formats/html/LinkFactoryImpl.java@8ea30d59ac41 (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/LinkFactoryImpl.java@8ea30d59ac41 (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/LinkFactoryImpl.java

Tue, 14 May 2013 10:14:51 -0700

author: jjg
date: Tue, 14 May 2013 10:14:51 -0700
changeset 1735: 8ea30d59ac41
parent 1691: f10cffab99b4
child 1736: 74cd21f2c2fe
permissions: -rw-r--r--

8010440: Replace int constants in LinkInfoImpl with enum
Reviewed-by: bpatel, darcy

 /*
  * Copyright (c) 2003, 2013, 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.formats.html;
 import java.util.List;
 import com.sun.javadoc.*;
 import com.sun.tools.doclets.internal.toolkit.*;
 import com.sun.tools.doclets.internal.toolkit.util.*;
 import com.sun.tools.doclets.internal.toolkit.util.links.*;
 /**
  * A factory that returns a link given the information about it.
  *
  *  <p><b>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.</b>
  *
  * @author Jamie Ho
  * @since 1.5
  */
 public class LinkFactoryImpl extends LinkFactory {
     private HtmlDocletWriter m_writer;
     public LinkFactoryImpl(HtmlDocletWriter writer) {
         m_writer = writer;
     }
     /**
      * {@inheritDoc}
      */
     protected LinkOutput getOutputInstance() {
         return new LinkOutputImpl();
     }
     /**
      * {@inheritDoc}
      */
     protected LinkOutput getClassLink(LinkInfo linkInfo) {
         LinkInfoImpl classLinkInfo = (LinkInfoImpl) linkInfo;
         boolean noLabel = linkInfo.label == null || linkInfo.label.length() == 0;
         ClassDoc classDoc = classLinkInfo.classDoc;
         //Create a tool tip if we are linking to a class or interface.  Don't
         //create one if we are linking to a member.
         String title =
             (classLinkInfo.where == null || classLinkInfo.where.length() == 0) ?
                 getClassToolTip(classDoc,
                     classLinkInfo.type != null &&
                     !classDoc.qualifiedTypeName().equals(classLinkInfo.type.qualifiedTypeName())) :
             "";
         StringBuilder label = new StringBuilder(
             classLinkInfo.getClassLinkLabel(m_writer.configuration));
         classLinkInfo.displayLength += label.length();
         Configuration configuration = m_writer.configuration;
         LinkOutputImpl linkOutput = new LinkOutputImpl();
         if (classDoc.isIncluded()) {
             if (configuration.isGeneratedDoc(classDoc)) {
                 DocPath filename = getPath(classLinkInfo);
                 if (linkInfo.linkToSelf ||
                                 !(DocPath.forName(classDoc)).equals(m_writer.filename)) {
                         linkOutput.append(m_writer.getHyperLinkString(
                                 filename.fragment(classLinkInfo.where),
                             label.toString(),
                             classLinkInfo.isStrong, classLinkInfo.styleName,
                             title, classLinkInfo.target));
                         if (noLabel && !classLinkInfo.excludeTypeParameterLinks) {
                             linkOutput.append(getTypeParameterLinks(linkInfo).toString());
                         }
                         return linkOutput;
                 }
             }
         } else {
             String crossLink = m_writer.getCrossClassLink(
                 classDoc.qualifiedName(), classLinkInfo.where,
                 label.toString(), classLinkInfo.isStrong, classLinkInfo.styleName,
                 true);
             if (crossLink != null) {
                 linkOutput.append(crossLink);
                 if (noLabel && !classLinkInfo.excludeTypeParameterLinks) {
                     linkOutput.append(getTypeParameterLinks(linkInfo).toString());
                 }
                 return linkOutput;
             }
         }
         // Can't link so just write label.
         linkOutput.append(label.toString());
         if (noLabel && !classLinkInfo.excludeTypeParameterLinks) {
             linkOutput.append(getTypeParameterLinks(linkInfo).toString());
         }
         return linkOutput;
     }
     /**
      * {@inheritDoc}
      */
     protected LinkOutput getTypeParameterLink(LinkInfo linkInfo,
         Type typeParam) {
         LinkInfoImpl typeLinkInfo = new LinkInfoImpl(m_writer.configuration,
                 ((LinkInfoImpl) linkInfo).getContext(), typeParam);
         typeLinkInfo.excludeTypeBounds = linkInfo.excludeTypeBounds;
         typeLinkInfo.excludeTypeParameterLinks = linkInfo.excludeTypeParameterLinks;
         typeLinkInfo.linkToSelf = linkInfo.linkToSelf;
         typeLinkInfo.isJava5DeclarationLocation = false;
         LinkOutput output = getLinkOutput(typeLinkInfo);
         ((LinkInfoImpl) linkInfo).displayLength += typeLinkInfo.displayLength;
         return output;
     }
     protected LinkOutput getTypeAnnotationLink(LinkInfo linkInfo,
             AnnotationDesc annotation) {
         throw new RuntimeException("Not implemented yet!");
     }
     public LinkOutput getTypeAnnotationLinks(LinkInfo linkInfo) {
         LinkOutput output = getOutputInstance();
         AnnotationDesc[] annotations;
         if (linkInfo.type instanceof AnnotatedType) {
             annotations = linkInfo.type.asAnnotatedType().annotations();
         } else if (linkInfo.type instanceof TypeVariable) {
             annotations = linkInfo.type.asTypeVariable().annotations();
         } else {
             return output;
         }
         if (annotations.length == 0)
             return output;
         List<String> annos = m_writer.getAnnotations(0, annotations, false, linkInfo.isJava5DeclarationLocation);
         boolean isFirst = true;
         for (String anno : annos) {
             if (!isFirst) {
                 linkInfo.displayLength += 1;
                 output.append(" ");
             }
             output.append(anno);
             isFirst = false;
         }
         if (!annos.isEmpty()) {
             linkInfo.displayLength += 1;
             output.append(" ");
         }
         return output;
     }
     /**
      * Given a class, return the appropriate tool tip.
      *
      * @param classDoc the class to get the tool tip for.
      * @return the tool tip for the appropriate class.
      */
     private String getClassToolTip(ClassDoc classDoc, boolean isTypeLink) {
         Configuration configuration = m_writer.configuration;
         if (isTypeLink) {
             return configuration.getText("doclet.Href_Type_Param_Title",
                 classDoc.name());
         } else if (classDoc.isInterface()){
             return configuration.getText("doclet.Href_Interface_Title",
                 Util.getPackageName(classDoc.containingPackage()));
         } else if (classDoc.isAnnotationType()) {
             return configuration.getText("doclet.Href_Annotation_Title",
                 Util.getPackageName(classDoc.containingPackage()));
         } else if (classDoc.isEnum()) {
             return configuration.getText("doclet.Href_Enum_Title",
                 Util.getPackageName(classDoc.containingPackage()));
         } else {
             return configuration.getText("doclet.Href_Class_Title",
                 Util.getPackageName(classDoc.containingPackage()));
         }
     }
     /**
      * Return path to the given file name in the given package. So if the name
      * passed is "Object.html" and the name of the package is "java.lang", and
      * if the relative path is "../.." then returned string will be
      * "../../java/lang/Object.html"
      *
      * @param linkInfo the information about the link.
      */
     private DocPath getPath(LinkInfoImpl linkInfo) {
         if (linkInfo.context == LinkInfoImpl.Kind.PACKAGE_FRAME) {
             //Not really necessary to do this but we want to be consistent
             //with 1.4.2 output.
             return DocPath.forName(linkInfo.classDoc);
         }
         return m_writer.pathToRoot.resolve(DocPath.forClass(linkInfo.classDoc));
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/formats/html/LinkFactoryImpl.java@8ea30d59ac41 (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/LinkFactoryImpl.java