JDK 17 jdk.javadoc.jmod - Java Document Tool
JDK 17 jdk.javadoc.jmod is the JMOD file for JDK 17 Java Document tool,
which can be invoked by the "javadoc" command.
JDK 17 Java Document tool compiled class files are stored in \fyicenter\jdk-17.0.5\jmods\jdk.javadoc.jmod.
JDK 17 Java Document tool compiled class files are also linked and stored in the \fyicenter\jdk-17.0.5\lib\modules JImage file.
JDK 17 Java Document tool source code files are stored in \fyicenter\jdk-17.0.5\lib\src.zip\jdk.javadoc.
You can click and view the content of each source code file in the list below.
✍: FYIcenter
⏎ jdk/javadoc/internal/doclets/toolkit/util/links/LinkFactory.java
/*
* Copyright (c) 2003, 2021, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package jdk.javadoc.internal.doclets.toolkit.util.links;
import java.util.List;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.TypeParameterElement;
import javax.lang.model.type.ArrayType;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.type.TypeVariable;
import javax.lang.model.type.WildcardType;
import javax.lang.model.util.SimpleTypeVisitor14;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
/**
* 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>
*/
public abstract class LinkFactory {
protected final Utils utils;
protected LinkFactory(Utils utils) {
this.utils = utils;
}
/**
* Returns 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) {
SimpleTypeVisitor14<Content, LinkInfo> linkVisitor = new SimpleTypeVisitor14<>() {
final Content link = newContent();
// handles primitives, no types and error types
@Override
protected Content defaultAction(TypeMirror type, LinkInfo linkInfo) {
link.add(utils.getTypeName(type, false));
return link;
}
int currentDepth = 0;
@Override
public Content visitArray(ArrayType type, LinkInfo linkInfo) {
// keep track of the dimension depth and replace the last dimension
// specifier with varargs, when the stack is fully unwound.
currentDepth++;
linkInfo.type = type.getComponentType();
visit(linkInfo.type, linkInfo);
currentDepth--;
if (utils.isAnnotated(type)) {
linkInfo.type = type;
link.add(" ");
link.add(getTypeAnnotationLinks(linkInfo));
}
// use vararg if required
if (linkInfo.isVarArg && currentDepth == 0) {
link.add("...");
} else {
link.add("[]");
}
return link;
}
@Override
public Content visitWildcard(WildcardType type, LinkInfo linkInfo) {
link.add(getTypeAnnotationLinks(linkInfo));
link.add("?");
TypeMirror extendsBound = type.getExtendsBound();
if (extendsBound != null) {
link.add(" extends ");
setBoundsLinkInfo(linkInfo, extendsBound);
link.add(getLink(linkInfo));
}
TypeMirror superBound = type.getSuperBound();
if (superBound != null) {
link.add(" super ");
setBoundsLinkInfo(linkInfo, superBound);
link.add(getLink(linkInfo));
}
return link;
}
@Override
public Content visitTypeVariable(TypeVariable type, LinkInfo linkInfo) {
link.add(getTypeAnnotationLinks(linkInfo));
TypeVariable typevariable = (utils.isArrayType(type))
? (TypeVariable) utils.getComponentType(type)
: type;
Element owner = typevariable.asElement().getEnclosingElement();
if (!linkInfo.excludeTypeParameterLinks && utils.isTypeElement(owner)) {
linkInfo.typeElement = (TypeElement) owner;
Content label = newContent();
label.add(utils.getTypeName(type, false));
linkInfo.label = label;
linkInfo.skipPreview = true;
link.add(getClassLink(linkInfo));
} else {
// No need to link method type parameters.
link.add(utils.getTypeName(typevariable, false));
}
if (!linkInfo.excludeTypeBounds) {
linkInfo.excludeTypeBounds = true;
TypeParameterElement tpe = ((TypeParameterElement) typevariable.asElement());
boolean more = false;
List<? extends TypeMirror> bounds = utils.getBounds(tpe);
for (TypeMirror bound : bounds) {
// we get everything as extends java.lang.Object we suppress
// all of them except those that have multiple extends
if (bounds.size() == 1 &&
bound.equals(utils.getObjectType()) &&
!utils.isAnnotated(bound)) {
continue;
}
link.add(more ? " & " : " extends ");
setBoundsLinkInfo(linkInfo, bound);
link.add(getLink(linkInfo));
more = true;
}
}
return link;
}
@Override
public Content visitDeclared(DeclaredType type, LinkInfo linkInfo) {
TypeMirror enc = type.getEnclosingType();
if (enc instanceof DeclaredType dt && utils.isGenericType(dt)) {
// If an enclosing type has type parameters render them as separate links as
// otherwise this information is lost. On the other hand, plain enclosing types
// are not linked separately as they are easy to reach from the nested type.
setEnclosingTypeLinkInfo(linkInfo, dt);
visitDeclared(dt, linkInfo);
link.add(".");
setEnclosingTypeLinkInfo(linkInfo, type);
}
link.add(getTypeAnnotationLinks(linkInfo));
linkInfo.typeElement = utils.asTypeElement(type);
link.add(getClassLink(linkInfo));
if (linkInfo.includeTypeParameterLinks()) {
link.add(getTypeParameterLinks(linkInfo));
}
return link;
}
};
return linkVisitor.visit(linkInfo.type, linkInfo);
} else if (linkInfo.typeElement != null) {
Content link = newContent();
link.add(getClassLink(linkInfo));
if (linkInfo.includeTypeParameterLinks()) {
link.add(getTypeParameterLinks(linkInfo));
}
return link;
} else {
return null;
}
}
private void setBoundsLinkInfo(LinkInfo linkInfo, TypeMirror bound) {
linkInfo.typeElement = null;
linkInfo.label = null;
linkInfo.type = bound;
linkInfo.skipPreview = false;
}
private void setEnclosingTypeLinkInfo(LinkInfo linkinfo, DeclaredType enclosing) {
linkinfo.typeElement = null;
linkinfo.label = null;
linkinfo.type = enclosing;
}
/**
* Returns a 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);
/**
* Returns links to the type parameters.
*
* @param linkInfo the information about the link to construct
* @return the links to the type parameters
*/
protected abstract Content getTypeParameterLinks(LinkInfo linkInfo);
/**
* Returns links to the type annotations.
*
* @param linkInfo the information about the link to construct
* @return the links to the type annotations
*/
public abstract Content getTypeAnnotationLinks(LinkInfo linkInfo);
}
⏎ jdk/javadoc/internal/doclets/toolkit/util/links/LinkFactory.java
Or download all of them as a single archive file:
File name: jdk.javadoc-17.0.5-src.zip File size: 587730 bytes Release date: 2022-09-13 Download
⇒ JDK 17 jdk.jcmd.jmod - JCmd Tool
2023-08-17, 6969👍, 0💬
Related Topics: