Package org.apache.maven.doxia.site.decoration.inheritance

## Class PathDescriptor

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

    public class PathDescriptor
    extends java.lang.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.

Version:
  $Id: PathDescriptor.java 1606231 2014-06-27 21:05:44Z hboutemy $
Author:
  Henning P. Schmiedehausen

### Constructor Summary

Constructors
`PathDescriptor​(java.lang.String path)` Deprecated. Construct a PathDescriptor from a path.
`PathDescriptor​(java.lang.String base, java.lang.String path)` Deprecated. Construct a PathDescriptor from a path and a base.
`PathDescriptor​(java.net.URL baseUrl, java.lang.String path)` Deprecated. Construct a PathDescriptor from a path and a base.

### Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
`java.net.URL` `getBaseUrl()` Deprecated. Get the base URL.
`java.lang.String` `getLocation()` Deprecated. Get the location for files.
`java.lang.String` `getPath()` Deprecated. Get the path.
`java.net.URL` `getPathUrl()` Deprecated. Get the path as a URL.
`boolean` `isFile()` Deprecated. Check if this PathDescriptor describes a file.
`boolean` `isRelative()` Deprecated. Check if this PathDescriptor describes a relative path.
`java.lang.String` `toString()` Deprecated.

### Methods inherited from class java.lang.Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

### Constructor Detail

#### PathDescriptor

    public PathDescriptor​(java.lang.String path)
                   throws java.net.MalformedURLException

Deprecated.
Construct a PathDescriptor from a path.

Parameters:
  `path` - the path.
Throws:
  `java.net.MalformedURLException` - if a URL cannot be formed from the path.

#### PathDescriptor

    public PathDescriptor​(java.lang.String base,
                          java.lang.String path)
                   throws java.net.MalformedURLException

Deprecated.
Construct a PathDescriptor from a path and a base.

Parameters:
  `base` - a base reference.
  `path` - the path.
Throws:
  `java.net.MalformedURLException` - if a URL cannot be formed from the path.

#### PathDescriptor

    public PathDescriptor​(java.net.URL baseUrl,
                          java.lang.String path)
                   throws java.net.MalformedURLException

Deprecated.
Construct a PathDescriptor from a path and a base.

Parameters:
  `baseUrl` - a base reference.
  `path` - the path.
Throws:
  `java.net.MalformedURLException` - if a URL cannot be formed from the path.

### Method Detail

#### 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 java.net.URL getBaseUrl()

Deprecated.
Get the base URL.

Returns:
  the base URL.

#### getPathUrl

    public java.net.URL getPathUrl()

Deprecated.
Get the path as a URL.

Returns:
  the path as a URL.

#### getPath

    public java.lang.String getPath()

Deprecated.
Get the path.

Returns:
  the path.

#### getLocation

    public java.lang.String getLocation()

Deprecated.
Get the location for files.

Returns:
  the location.

#### toString

    public java.lang.String toString()

Deprecated.

Overrides:
  `toString` in class `java.lang.Object`