java.lang.Object
org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

public class PathDescriptor extends Object
Deprecated.
use URIPathDescriptor instead.
This class holds an instance of a maven path. This consists of a relative path (e.g. images/maven-logo.png) and a base reference which can also be a relative path (e.g. '.' or '../doxia') or an URL that is used for an absolute anchor.
  • Field Details

    • baseUrl

      private final URL baseUrl
      Deprecated.
    • pathUrl

      private final URL pathUrl
      Deprecated.
    • relativePath

      private final String relativePath
      Deprecated.
  • Constructor Details

    • PathDescriptor

      public PathDescriptor(String path) throws MalformedURLException
      Deprecated.
      Construct a PathDescriptor from a path.
      Parameters:
      path - the path.
      Throws:
      MalformedURLException - if a URL cannot be formed from the path.
    • PathDescriptor

      public PathDescriptor(String base, String path) throws MalformedURLException
      Deprecated.
      Construct a PathDescriptor from a path and a base.
      Parameters:
      base - a base reference.
      path - the path.
      Throws:
      MalformedURLException - if a URL cannot be formed from the path.
    • PathDescriptor

      public PathDescriptor(URL baseUrl, String path) throws MalformedURLException
      Deprecated.
      Construct a PathDescriptor from a path and a base.
      Parameters:
      baseUrl - a base reference.
      path - the path.
      Throws:
      MalformedURLException - if a URL cannot be formed from the path.
  • Method Details

    • buildBaseUrl

      private static URL buildBaseUrl(String base) throws MalformedURLException
      Deprecated.
      Throws:
      MalformedURLException
    • buildUrl

      private static URL buildUrl(URL baseUrl, String path) throws MalformedURLException
      Deprecated.
      Throws:
      MalformedURLException
    • isFile

      public boolean isFile()
      Deprecated.
      Check if this PathDescriptor describes a file.
      Returns:
      true for file, false otherwise.
    • isRelative

      public boolean isRelative()
      Deprecated.
      Check if this PathDescriptor describes a relative path.
      Returns:
      true if getPathUrl() returns null.
    • getBaseUrl

      public URL getBaseUrl()
      Deprecated.
      Get the base URL.
      Returns:
      the base URL.
    • getPathUrl

      public URL getPathUrl()
      Deprecated.
      Get the path as a URL.
      Returns:
      the path as a URL.
    • getPath

      public String getPath()
      Deprecated.
      Get the path.
      Returns:
      the path.
    • getLocation

      public String getLocation()
      Deprecated.
      Get the location for files.
      Returns:
      the location.
    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object