Modifier and Type	Class and Description
private static class	Extern.Fault
private static class	Extern.Item Stores the info for one external doc set

Modifier and Type	Field and Description
private final BaseConfiguration	configuration The global configuration information for this run.
private boolean	linkoffline True if we are using -linkoffline and false if -link is used instead.
private Map<String, Extern.Item>	moduleItems Map element names onto Extern Item objects.
private Map<String, Map<String, Extern.Item>>	packageItems
private final Resources	resources
private final Utils	utils

Access	Constructor and Description
public	Extern(BaseConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
private String	adjustEndFileSeparator(String url) If the URL or Directory path is missing end file separator, add that.
private String	Returns: the module name to use according to actual modularity of the package checkLinkCompatibility(String the package name packageName, String the module name or null moduleName, String the documentation path path, boolean whether to print a diagnostic message in case of modularity mismatch showDiagnostic) Check if the external documentation format matches our internal model of the code.
public void	checkPlatformLinks(String path or URL to properties file containing platform documentation URLs, or null linkPlatformProperties, Reporter the `DocErrorReporter` used to report errors reporter) Check whether links to platform documentation are configured.
private Extern.Item	findElementItem(Element Element element) Get the Extern Item object associated with this element name.
private String	Returns: the custom URL as String getCustomPlatformDocs(int the platform version number version, String path pointing to a properties file linkPlatformProperties) Retrieve and return the custom URL for the platform API documentation for the given `version` from the properties file at `linkPlatformProperties`.
private String	Returns: the URL as String getDefaultPlatformDocs(int the platform version number version) Return the default URL for the platform API documentation for the given `version`.
public DocLink	Returns: if external return converted link else return null getExternalLink(Element The element . element, DocPath The relative path. relativepath, String The link to convert. filename) Convert a link to be an external link if appropriate.
public DocLink	getExternalLink(Element element, DocPath relativepath, String filename, String memberName)
private String	getLastPathComponent(URL u)
private String	Returns: old-form HTML name getOldFormHtmlName(String the string that needs to be converted to a valid HTML name name) Converts a name to an old-form HTML name (old-form id).
private DocPath	Returns: the resource path getPlatformElementList(int the platform version number version) Return the resource path for the package or element list for the given `version`.
private int	Returns: the source version number getSourceVersionNumber() Return the source version number used in the current execution of javadoc.
public boolean	Returns: true if the element is externally documented isExternal(Element an Element. element) Determine if a element item is externally documented.
public boolean	Returns: true if the element is a module isModule(String name of the element. elementName) Determine if a element item is a module or not.
private boolean	Returns: True if docs use old-form anchors isOldFormPlatformDocs(int version) Checks if platform docs for the specified version use old-form anchors.
private boolean	Returns: true if it is a pre-release version isPrerelease(int the source version number sourceVersion) Return true if the given `sourceVersion` is the same as the current doclet version and is a pre-release version.
public boolean	isUrl(String urlCandidate)
public boolean	Returns: true if successful, false otherwise link(String URL or Directory path. url, Reporter The `DocErrorReporter` used to report errors. reporter) Build the extern element list from given URL or the directory path, as specified with the "-link" flag.
public boolean	Returns: true if successful, false otherwise link(String URL or Directory path. url, String This can be another URL for "element-list" or ordinary file. elemlisturl, Reporter The `DocErrorReporter` used to report errors. reporter) Build the extern element list from given URL or the directory path, as specified with the "-linkoffline" flag.
private boolean	link(String url, String elemlisturl, Reporter reporter, boolean linkoffline)
private InputStream	Returns: the stream open(URL the URL url) Open a stream to a URL, following a limited number of redirects if necessary.
private void	printModularityMismatchDiagnostic(String key, Object arg)
private void	readElementList(DocFile file, String path, boolean isOldFormDoc)
private void	readElementList(InputStream InputStream from the "element-list" file. input, String URL or the directory path to the elements. path, boolean Is path relative? relative, int The version of platform libraries the element list belongs to, or `0` if it does not belong to a platform libraries doc bundle. platformVersion, boolean isOldFormDoc) Read the file "element-list" and for each element name found, create Extern object and associate it with the element name in the map.
private void	readElementListFromFile(String URL or directory path to the elements. path, DocFile Path to the local "element-list" file. elemListPath) Read the "element-list" file which is available locally.
private void	readElementListFromURL(String Path to the elements. urlpath, URL URL or the path to the "element-list" file. elemlisturlpath) Fetch the URL and read the "element-list" file.
private void	readPackageListFromURL(String Path to the packages. urlpath, URL URL or the path to the "package-list" file. elemlisturlpath) Fetch the URL and read the "package-list" file.
private URL	toURL(String url)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

configuration	back to summary
private final BaseConfiguration configuration The global configuration information for this run.

linkoffline	back to summary
private boolean linkoffline True if we are using -linkoffline and false if -link is used instead.

moduleItems	back to summary
private Map<String, Extern.Item> moduleItems Map element names onto Extern Item objects. Lazily initialized.

packageItems	back to summary
private Map<String, Map<String, Extern.Item>> packageItems

resources	back to summary
private final Resources resources

utils	back to summary
private final Utils utils

Constructor Detail

Extern	back to summary
public Extern(BaseConfiguration configuration)

Method Detail

adjustEndFileSeparator	back to summary
private String adjustEndFileSeparator(String url) If the URL or Directory path is missing end file separator, add that.

checkLinkCompatibility	back to summary
private String checkLinkCompatibility(String packageName, String moduleName, String path, boolean showDiagnostic) Check if the external documentation format matches our internal model of the code. Returns the module name to use for external reference lookup according to the actual modularity of the external package (and regardless of modularity of documentation). Parameters packageName:String the package name moduleName:String the module name or null path:String the documentation path showDiagnostic:boolean whether to print a diagnostic message in case of modularity mismatch Returns:String the module name to use according to actual modularity of the package

checkLinkCompatibility

back to summary

private String checkLinkCompatibility(String packageName, String moduleName, String path, boolean showDiagnostic)

Check if the external documentation format matches our internal model of the code. Returns the module name to use for external reference lookup according to the actual modularity of the external package (and regardless of modularity of documentation).

Parameters

packageName:String: the package name
moduleName:String: the module name or null
path:String: the documentation path
showDiagnostic:boolean: whether to print a diagnostic message in case of modularity mismatch

Returns:String

the module name to use according to actual modularity of the package

checkPlatformLinks back to summary

checkPlatformLinks	back to summary
public void checkPlatformLinks(String linkPlatformProperties, Reporter reporter) Check whether links to platform documentation are configured. If not then configure links using the documentation URL defined in `linkPlatformProperties` or the default documentation URL if that parameter is `null`. Parameters linkPlatformProperties:String path or URL to properties file containing platform documentation URLs, or null reporter:Reporter the `DocErrorReporter` used to report errors

public void checkPlatformLinks(String linkPlatformProperties, Reporter reporter)

Check whether links to platform documentation are configured. If not then configure links using the documentation URL defined in linkPlatformProperties or the default documentation URL if that parameter is null.

Parameters

linkPlatformProperties:String: path or URL to properties file containing platform documentation URLs, or null
reporter:Reporter: the DocErrorReporter used to report errors

findElementItem	back to summary
private Extern.Item findElementItem(Element element) Get the Extern Item object associated with this element name. Parameters element:Element Element

findElementItem

back to summary

private Extern.Item findElementItem(Element element)

Get the Extern Item object associated with this element name.

Parameters

element:Element: Element

getCustomPlatformDocs back to summary

getCustomPlatformDocs	back to summary
private String getCustomPlatformDocs(int version, String linkPlatformProperties) throws Fault Retrieve and return the custom URL for the platform API documentation for the given `version` from the properties file at `linkPlatformProperties`. Parameters version:int the platform version number linkPlatformProperties:String path pointing to a properties file Returns:String the custom URL as String

private String getCustomPlatformDocs(int version, String linkPlatformProperties) throws Fault

Retrieve and return the custom URL for the platform API documentation for the given version from the properties file at linkPlatformProperties.

Parameters

version:int: the platform version number
linkPlatformProperties:String: path pointing to a properties file

Returns:String

the custom URL as String

getDefaultPlatformDocs back to summary

getDefaultPlatformDocs	back to summary
private String getDefaultPlatformDocs(int version) Return the default URL for the platform API documentation for the given `version`. Parameters version:int the platform version number Returns:String the URL as String

private String getDefaultPlatformDocs(int version)

Return the default URL for the platform API documentation for the given version.

Parameters

version:int: the platform version number

Returns:String

the URL as String

getExternalLink	back to summary
public DocLink getExternalLink(Element element, DocPath relativepath, String filename) Convert a link to be an external link if appropriate. Parameters element:Element The element . relativepath:DocPath The relative path. filename:String The link to convert. Returns:DocLink if external return converted link else return null

getExternalLink

back to summary

public DocLink getExternalLink(Element element, DocPath relativepath, String filename)

Convert a link to be an external link if appropriate.

Parameters

element:Element: The element .
relativepath:DocPath: The relative path.
filename:String: The link to convert.

Returns:DocLink

if external return converted link else return null

getExternalLink	back to summary
public DocLink getExternalLink(Element element, DocPath relativepath, String filename, String memberName)

getLastPathComponent	back to summary
private String getLastPathComponent(URL u)

getOldFormHtmlName	back to summary
private String getOldFormHtmlName(String name) Converts a name to an old-form HTML name (old-form id). Parameters name:String the string that needs to be converted to a valid HTML name Returns:String old-form HTML name

getOldFormHtmlName

back to summary

private String getOldFormHtmlName(String name)

Converts a name to an old-form HTML name (old-form id).

Parameters

name:String: the string that needs to be converted to a valid HTML name

Returns:String

old-form HTML name

getPlatformElementList back to summary

getPlatformElementList	back to summary
private DocPath getPlatformElementList(int version) Return the resource path for the package or element list for the given `version`. Parameters version:int the platform version number Returns:DocPath the resource path

private DocPath getPlatformElementList(int version)

Return the resource path for the package or element list for the given version.

Parameters

version:int: the platform version number

Returns:DocPath

the resource path

getSourceVersionNumber	back to summary
private int getSourceVersionNumber() Return the source version number used in the current execution of javadoc. Returns:int the source version number

getSourceVersionNumber

back to summary

private int getSourceVersionNumber()

Return the source version number used in the current execution of javadoc.

Returns:int: the source version number

isExternal	back to summary
public boolean isExternal(Element element) Determine if a element item is externally documented. Parameters element:Element an Element. Returns:boolean true if the element is externally documented

isExternal

back to summary

public boolean isExternal(Element element)

Determine if a element item is externally documented.

Parameters

element:Element: an Element.

Returns:boolean

true if the element is externally documented

isModule	back to summary
public boolean isModule(String elementName) Determine if a element item is a module or not. Parameters elementName:String name of the element. Returns:boolean true if the element is a module

isModule

back to summary

public boolean isModule(String elementName)

Determine if a element item is a module or not.

Parameters

elementName:String: name of the element.

Returns:boolean

true if the element is a module

isOldFormPlatformDocs	back to summary
private boolean isOldFormPlatformDocs(int version) Checks if platform docs for the specified version use old-form anchors. Old-form anchors are used by Oracle docs for JDKs 8 and 9. It can be checked on https://docs.oracle.com/javase//docs/api Returns:boolean True if docs use old-form anchors

isOldFormPlatformDocs

back to summary

private boolean isOldFormPlatformDocs(int version)

Checks if platform docs for the specified version use old-form anchors. Old-form anchors are used by Oracle docs for JDKs 8 and 9. It can be checked on https://docs.oracle.com/javase//docs/api

Returns:boolean: True if docs use old-form anchors

isPrerelease back to summary

isPrerelease	back to summary
private boolean isPrerelease(int sourceVersion) Return true if the given `sourceVersion` is the same as the current doclet version and is a pre-release version. Parameters sourceVersion:int the source version number Returns:boolean true if it is a pre-release version

private boolean isPrerelease(int sourceVersion)

Return true if the given sourceVersion is the same as the current doclet version and is a pre-release version.

Parameters

sourceVersion:int: the source version number

Returns:boolean

true if it is a pre-release version

isUrl	back to summary
public boolean isUrl(String urlCandidate)

link back to summary

link	back to summary
public boolean link(String url, Reporter reporter) throws DocFileIOException Build the extern element list from given URL or the directory path, as specified with the "-link" flag. Flag error if the "-link" or "-linkoffline" option is already used. Parameters url:String URL or Directory path. reporter:Reporter The `DocErrorReporter` used to report errors. Returns:boolean true if successful, false otherwise Exceptions DocFileIOException: if there is a problem reading a element list file

public boolean link(String url, Reporter reporter) throws DocFileIOException

Build the extern element list from given URL or the directory path, as specified with the "-link" flag. Flag error if the "-link" or "-linkoffline" option is already used.

Parameters

url:String: URL or Directory path.
reporter:Reporter: The DocErrorReporter used to report errors.

Returns:boolean

true if successful, false otherwise

Exceptions

DocFileIOException:: if there is a problem reading a element list file

link back to summary

link	back to summary
public boolean link(String url, String elemlisturl, Reporter reporter) throws DocFileIOException Build the extern element list from given URL or the directory path, as specified with the "-linkoffline" flag. Flag error if the "-link" or "-linkoffline" option is already used. Parameters url:String URL or Directory path. elemlisturl:String This can be another URL for "element-list" or ordinary file. reporter:Reporter The `DocErrorReporter` used to report errors. Returns:boolean true if successful, false otherwise Exceptions DocFileIOException: if there is a problem reading the element list file

public boolean link(String url, String elemlisturl, Reporter reporter) throws DocFileIOException

Build the extern element list from given URL or the directory path, as specified with the "-linkoffline" flag. Flag error if the "-link" or "-linkoffline" option is already used.

Parameters

url:String: URL or Directory path.
elemlisturl:String: This can be another URL for "element-list" or ordinary file.
reporter:Reporter: The DocErrorReporter used to report errors.

Returns:boolean

true if successful, false otherwise

Exceptions

DocFileIOException:: if there is a problem reading the element list file

link	back to summary
private boolean link(String url, String elemlisturl, Reporter reporter, boolean linkoffline) throws DocFileIOException

open	back to summary
private InputStream open(URL url) throws IOException Open a stream to a URL, following a limited number of redirects if necessary. Parameters url:URL the URL Returns:InputStream the stream Exceptions IOException: if an error occurred accessing the URL

open

back to summary

private InputStream open(URL url) throws IOException

Open a stream to a URL, following a limited number of redirects if necessary.

Parameters

url:URL: the URL

Returns:InputStream

the stream

Exceptions

IOException:: if an error occurred accessing the URL

printModularityMismatchDiagnostic	back to summary
private void printModularityMismatchDiagnostic(String key, Object arg)

readElementList	back to summary
private void readElementList(DocFile file, String path, boolean isOldFormDoc) throws Fault, DocFileIOException

readElementList back to summary

readElementList	back to summary
private void readElementList(InputStream input, String path, boolean relative, int platformVersion, boolean isOldFormDoc) throws IOException Read the file "element-list" and for each element name found, create Extern object and associate it with the element name in the map. Parameters input:InputStream InputStream from the "element-list" file. path:String URL or the directory path to the elements. relative:boolean Is path relative? platformVersion:int The version of platform libraries the element list belongs to, or `0` if it does not belong to a platform libraries doc bundle. Exceptions IOException: if there is a problem reading or closing the stream

private void readElementList(InputStream input, String path, boolean relative, int platformVersion, boolean isOldFormDoc) throws IOException

Read the file "element-list" and for each element name found, create Extern object and associate it with the element name in the map.

Parameters

input:InputStream: InputStream from the "element-list" file.
path:String: URL or the directory path to the elements.
relative:boolean: Is path relative?
platformVersion:int: The version of platform libraries the element list belongs to, or 0 if it does not belong to a platform libraries doc bundle.

Exceptions

IOException:: if there is a problem reading or closing the stream

readElementListFromFile	back to summary
private void readElementListFromFile(String path, DocFile elemListPath) throws Fault, DocFileIOException Read the "element-list" file which is available locally. Parameters path:String URL or directory path to the elements. elemListPath:DocFile Path to the local "element-list" file. Exceptions Fault: if an error occurs that can be treated as a warning DocFileIOException: if there is a problem opening the element list file

readElementListFromFile

back to summary

private void readElementListFromFile(String path, DocFile elemListPath) throws Fault, DocFileIOException

Read the "element-list" file which is available locally.

Parameters

path:String: URL or directory path to the elements.
elemListPath:DocFile: Path to the local "element-list" file.

Exceptions

Fault:: if an error occurs that can be treated as a warning
DocFileIOException:: if there is a problem opening the element list file

readElementListFromURL	back to summary
private void readElementListFromURL(String urlpath, URL elemlisturlpath) throws Fault Fetch the URL and read the "element-list" file. Parameters urlpath:String Path to the elements. elemlisturlpath:URL URL or the path to the "element-list" file.

readElementListFromURL

back to summary

private void readElementListFromURL(String urlpath, URL elemlisturlpath) throws Fault

Fetch the URL and read the "element-list" file.

Parameters

urlpath:String: Path to the elements.
elemlisturlpath:URL: URL or the path to the "element-list" file.

readPackageListFromURL	back to summary
private void readPackageListFromURL(String urlpath, URL elemlisturlpath) throws Fault Fetch the URL and read the "package-list" file. Parameters urlpath:String Path to the packages. elemlisturlpath:URL URL or the path to the "package-list" file.

readPackageListFromURL

back to summary

private void readPackageListFromURL(String urlpath, URL elemlisturlpath) throws Fault

Fetch the URL and read the "package-list" file.

Parameters

urlpath:String: Path to the packages.
elemlisturlpath:URL: URL or the path to the "package-list" file.

toURL	back to summary
private URL toURL(String url) throws Fault Annotations @SuppressWarnings:deprecation

jdk.javadoc.internal.doclets.toolkit.util back to summary

private Class Extern.Fault

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
jdk.javadoc.internal.doclets.toolkit.util.Extern.Fault

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	Fault(String msg, Exception cause)

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

Fault	back to summary
pack-priv Fault(String msg, Exception cause)

jdk.javadoc.internal.doclets.toolkit.util back to summary

private Class Extern.Item

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.util.Extern.Item

Stores the info for one external doc set

Field Summary

Modifier and Type	Field and Description
pack-priv final String	elementName Element name, found in the "element-list" file in the `path`.
pack-priv final DocPath	path The URL or the directory path at which the element documentation will be available.
pack-priv final boolean	relative If given path is directory path then true else if it is a URL then false.
pack-priv final boolean	useOldFormId Indicates that docs use old-form of anchors.

Constructor Summary

Access	Constructor and Description
pack-priv	Item(String Element name found in the "element-list" file. elementName, DocPath URL or Directory path from where the "element-list" file is picked. path, boolean True if path is URL, false if directory path. relative, boolean useOldFormId) Constructor to build a Extern Item object and map it with the element name.

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. String representation of "this" with elementname and the path.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

elementName	back to summary
pack-priv final String elementName Element name, found in the "element-list" file in the `path`.

path	back to summary
pack-priv final DocPath path The URL or the directory path at which the element documentation will be available.

relative	back to summary
pack-priv final boolean relative If given path is directory path then true else if it is a URL then false.

useOldFormId	back to summary
pack-priv final boolean useOldFormId Indicates that docs use old-form of anchors.

Constructor Detail

Item

back to summary

pack-priv Item(String elementName, DocPath path, boolean relative, boolean useOldFormId)

Constructor to build a Extern Item object and map it with the element name. If the same element name is found in the map, then the first mapped Item object or offline location will be retained.

Parameters

elementName:String: Element name found in the "element-list" file.
path:DocPath: URL or Directory path from where the "element-list" file is picked.
relative:boolean: True if path is URL, false if directory path.

Method Detail

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

String representation of "this" with elementname and the path.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

public Class Extern

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Extern.Fault

Field Summary

Constructor Summary

Field Detail

Constructor Detail

private Class Extern.Item

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail