java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.DocPath

@Deprecated public class DocPath extends Object
Deprecated.
Abstraction for immutable relative paths. Paths always use '/' as a separator, and never begin or end with '/'.

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.

  • Field Details

    • path

      private final String path
      Deprecated.
    • empty

      public static final DocPath empty
      Deprecated.
      The empty path.
    • parent

      public static final DocPath parent
      Deprecated.
      The empty path.
  • Constructor Details

    • DocPath

      protected DocPath(String p)
      Deprecated.
  • Method Details

    • create

      public static DocPath create(String p)
      Deprecated.
      Create a path from a string.
    • forClass

      public static DocPath forClass(ClassDoc cd)
      Deprecated.
      Return the path for a class. For example, if the class is java.lang.Object, the path is java/lang/Object.html.
    • forName

      public static DocPath forName(ClassDoc cd)
      Deprecated.
      Return the path for the simple name of the class. For example, if the class is java.lang.Object, the path is Object.html.
    • forPackage

      public static DocPath forPackage(ClassDoc cd)
      Deprecated.
      Return the path for the package of a class. For example, if the class is java.lang.Object, the path is java/lang.
    • forPackage

      public static DocPath forPackage(PackageDoc pd)
      Deprecated.
      Return the path for a package. For example, if the package is java.lang, the path is java/lang.
    • forRoot

      public static DocPath forRoot(PackageDoc pd)
      Deprecated.
      Return the inverse path for a package. For example, if the package is java.lang, the inverse path is ../...
    • relativePath

      public static DocPath relativePath(PackageDoc from, PackageDoc to)
      Deprecated.
      Return the relative path from one package to another.
    • equals

      public boolean equals(Object other)
      Deprecated.
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object
    • basename

      public DocPath basename()
      Deprecated.
    • parent

      public DocPath parent()
      Deprecated.
    • resolve

      public DocPath resolve(String p)
      Deprecated.
      Return the path formed by appending the specified string to the current path.
    • resolve

      public DocPath resolve(DocPath p)
      Deprecated.
      Return the path by appending the specified path to the current path.
    • invert

      public DocPath invert()
      Deprecated.
      Return the inverse path for this path. For example, if the path is a/b/c, the inverse path is ../../..
    • isEmpty

      public boolean isEmpty()
      Deprecated.
      Return true if this path is empty.
    • fragment

      public DocLink fragment(String fragment)
      Deprecated.
    • query

      public DocLink query(String query)
      Deprecated.
    • getPath

      public String getPath()
      Deprecated.
      Return this path as a string.