Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse Extern

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.util.Extern
public class Extern extends Object
Process and manage “-link” and “-linkoffline” to external packages.

The options “-link” and “-linkoffline” both depend on the fact that Javadoc now generates “package-list”(lists all the packages which are getting documented) file in the current or the destination directory, while generating the documentation.

  • Konstruktordetails

  • Methodendetails

    • isExternal

      public boolean isExternal(Element element)
      Determine if a element item is externally documented.
      Parameter:
      element - an Element.
      Gibt zurück:
      true if the element is externally documented

    • isModule

      public boolean isModule(String elementName)
      Determine if a element item is a module or not.
      Parameter:
      elementName - name of the element.
      Gibt zurück:
      true if the element is a module

    • getExternalLink

      public DocLink getExternalLink(Element element, DocPath relativepath, String filename)
      Convert a link to be an external link if appropriate.
      Parameter:
      element - The element .
      relativepath - The relative path.
      filename - The link to convert.
      Gibt zurück:
      if external return converted link else return null

    • getExternalLink

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

    • link

      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.

      Parameter:
      url - URL or Directory path.
      reporter - The DocErrorReporter used to report errors.
      Gibt zurück:
      true if successful, false otherwise
      Löst aus:
      DocFileIOException - if there is a problem reading a element list file

    • link

      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.

      Parameter:
      url - URL or Directory path.
      elemlisturl - This can be another URL for “element-list” or ordinary file.
      reporter - The DocErrorReporter used to report errors.
      Gibt zurück:
      true if successful, false otherwise
      Löst aus:
      DocFileIOException - if there is a problem reading the element list file

    • checkPlatformLinks

      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.

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

    • isUrl

      public boolean isUrl(String urlCandidate)