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

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/LinkFactory.java@7a9ef837e57f (annotated)

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

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

author: jjg
date: Tue, 14 May 2013 10:14:52 -0700
changeset 1737: 7a9ef837e57f
parent 1736: 74cd21f2c2fe
child 1741: 4c43e51433ba
permissions: -rw-r--r--

8011650: reduce use of RawHtml nodes in doclet
Reviewed-by: 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.internal.toolkit.util.links;
 import com.sun.javadoc.*;
 import com.sun.tools.doclets.internal.toolkit.Content;
 /**
  * A factory that constructs links from given link information.
  *
  *  <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 abstract class LinkFactory {
     /**
      * Return an empty instance of a content object.
      *
      * @return an empty instance of a content object.
      */
     protected abstract Content newContent();
     /**
      * Constructs a link from the given link information.
      *
      * @param linkInfo the information about the link.
      * @return the output of the link.
      */
     public Content getLink(LinkInfo linkInfo) {
         if (linkInfo.type != null) {
             Type type = linkInfo.type;
             Content link = newContent();
             if (type.isPrimitive()) {
                 //Just a primitive.
                 linkInfo.displayLength += type.typeName().length();
                 link.addContent(type.typeName());
             } else if (type.asAnnotatedType() != null && type.dimension().length() == 0) {
                 link.addContent(getTypeAnnotationLinks(linkInfo));
                 linkInfo.type = type.asAnnotatedType().underlyingType();
                 link.addContent(getLink(linkInfo));
                 return link;
             } else if (type.asWildcardType() != null) {
                 //Wildcard type.
                 linkInfo.isTypeBound = true;
                 linkInfo.displayLength += 1;
                 link.addContent("?");
                 WildcardType wildcardType = type.asWildcardType();
                 Type[] extendsBounds = wildcardType.extendsBounds();
                 for (int i = 0; i < extendsBounds.length; i++) {
                     linkInfo.displayLength += i > 0 ? 2 : 9;
                     link.addContent(i > 0 ? ", " : " extends ");
                     setBoundsLinkInfo(linkInfo, extendsBounds[i]);
                     link.addContent(getLink(linkInfo));
                 }
                 Type[] superBounds = wildcardType.superBounds();
                 for (int i = 0; i < superBounds.length; i++) {
                     linkInfo.displayLength += i > 0 ? 2 : 7;
                     link.addContent(i > 0 ? ", " : " super ");
                     setBoundsLinkInfo(linkInfo, superBounds[i]);
                     link.addContent(getLink(linkInfo));
                 }
             } else if (type.asTypeVariable()!= null) {
                 link.addContent(getTypeAnnotationLinks(linkInfo));
                 linkInfo.isTypeBound = true;
                 //A type variable.
                 Doc owner = type.asTypeVariable().owner();
                 if ((! linkInfo.excludeTypeParameterLinks) &&
                         owner instanceof ClassDoc) {
                     linkInfo.classDoc = (ClassDoc) owner;
                     Content label = newContent();
                     label.addContent(type.typeName());
                     linkInfo.label = label;
                     link.addContent(getClassLink(linkInfo));
                 } else {
                     //No need to link method type parameters.
                     linkInfo.displayLength += type.typeName().length();
                     link.addContent(type.typeName());
                 }
                 Type[] bounds = type.asTypeVariable().bounds();
                 if (! linkInfo.excludeTypeBounds) {
                     linkInfo.excludeTypeBounds = true;
                     for (int i = 0; i < bounds.length; i++) {
                         linkInfo.displayLength += i > 0 ? 2 : 9;
                         link.addContent(i > 0 ? " & " : " extends ");
                         setBoundsLinkInfo(linkInfo, bounds[i]);
                         link.addContent(getLink(linkInfo));
                     }
                 }
             } else if (type.asClassDoc() != null) {
                 //A class type.
                 if (linkInfo.isTypeBound &&
                         linkInfo.excludeTypeBoundsLinks) {
                     //Since we are excluding type parameter links, we should not
                     //be linking to the type bound.
                     linkInfo.displayLength += type.typeName().length();
                     link.addContent(type.typeName());
                     link.addContent(getTypeParameterLinks(linkInfo));
                     return link;
                 } else {
                     linkInfo.classDoc = type.asClassDoc();
                     link = newContent();
                     link.addContent(getClassLink(linkInfo));
                     if (linkInfo.includeTypeAsSepLink) {
                         link.addContent(getTypeParameterLinks(linkInfo, false));
                     }
                 }
             }
             if (linkInfo.isVarArg) {
                 if (type.dimension().length() > 2) {
                     //Javadoc returns var args as array.
                     //Strip out the first [] from the var arg.
                     linkInfo.displayLength += type.dimension().length()-2;
                     link.addContent(type.dimension().substring(2));
                 }
                 linkInfo.displayLength += 3;
                 link.addContent("...");
             } else {
                 while (type != null && type.dimension().length() > 0) {
                     linkInfo.displayLength += type.dimension().length();
                     if (type.asAnnotatedType() != null) {
                         linkInfo.type = type;
                         link.addContent(" ");
                         link.addContent(getTypeAnnotationLinks(linkInfo));
                         link.addContent("[]");
                         type = type.asAnnotatedType().underlyingType().getElementType();
                     } else {
                         link.addContent("[]");
                         type = type.getElementType();
                     }
                 }
                 linkInfo.type = type;
                 Content newLink = newContent();
                 newLink.addContent(getTypeAnnotationLinks(linkInfo));
                 newLink.addContent(link);
                 link = newLink;
             }
             return link;
         } else if (linkInfo.classDoc != null) {
             //Just a class link
             Content link = newContent();
             link.addContent(getClassLink(linkInfo));
             if (linkInfo.includeTypeAsSepLink) {
                 link.addContent(getTypeParameterLinks(linkInfo, false));
             }
             return link;
         } else {
             return null;
         }
     }
     private void setBoundsLinkInfo(LinkInfo linkInfo, Type bound) {
         linkInfo.classDoc = null;
         linkInfo.label = null;
         linkInfo.type = bound;
     }
     /**
      * Return the link to the given class.
      *
      * @param linkInfo the information about the link to construct.
      *
      * @return the link for the given class.
      */
     protected abstract Content getClassLink(LinkInfo linkInfo);
     /**
      * Return the link to the given type parameter.
      *
      * @param linkInfo     the information about the link to construct.
      * @param typeParam the type parameter to link to.
      */
     protected abstract Content getTypeParameterLink(LinkInfo linkInfo,
         Type typeParam);
     protected abstract Content getTypeAnnotationLink(LinkInfo linkInfo,
             AnnotationDesc annotation);
     /**
      * Return the links to the type parameters.
      *
      * @param linkInfo     the information about the link to construct.
      * @return the links to the type parameters.
      */
     public Content getTypeParameterLinks(LinkInfo linkInfo) {
         return getTypeParameterLinks(linkInfo, true);
     }
     /**
      * Return the links to the type parameters.
      *
      * @param linkInfo     the information about the link to construct.
      * @param isClassLabel true if this is a class label.  False if it is
      *                     the type parameters portion of the link.
      * @return the links to the type parameters.
      */
     public Content getTypeParameterLinks(LinkInfo linkInfo, boolean isClassLabel) {
         Content links = newContent();
         Type[] vars;
         if (linkInfo.executableMemberDoc != null) {
             vars = linkInfo.executableMemberDoc.typeParameters();
         } else if (linkInfo.type != null &&
                 linkInfo.type.asParameterizedType() != null){
             vars =  linkInfo.type.asParameterizedType().typeArguments();
         } else if (linkInfo.classDoc != null){
             vars = linkInfo.classDoc.typeParameters();
         } else {
             //Nothing to document.
             return links;
         }
         if (((linkInfo.includeTypeInClassLinkLabel && isClassLabel) ||
              (linkInfo.includeTypeAsSepLink && ! isClassLabel)
               )
             && vars.length > 0) {
             linkInfo.displayLength += 1;
             links.addContent("<");
             for (int i = 0; i < vars.length; i++) {
                 if (i > 0) {
                     linkInfo.displayLength += 1;
                     links.addContent(",");
                 }
                 links.addContent(getTypeParameterLink(linkInfo, vars[i]));
             }
             linkInfo.displayLength += 1;
             links.addContent(">");
         }
         return links;
     }
     public Content getTypeAnnotationLinks(LinkInfo linkInfo) {
         Content links = newContent();
         if (linkInfo.type.asAnnotatedType() == null)
             return links;
         AnnotationDesc[] annotations = linkInfo.type.asAnnotatedType().annotations();
         for (int i = 0; i < annotations.length; i++) {
             if (i > 0) {
                 linkInfo.displayLength += 1;
                 links.addContent(" ");
             }
             links.addContent(getTypeAnnotationLink(linkInfo, annotations[i]));
         }
         linkInfo.displayLength += 1;
         links.addContent(" ");
         return links;
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/LinkFactory.java@7a9ef837e57f (annotated)

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