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

Class PathDescriptor

java.lang.Object

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

Deprecated.

use URIPathDescriptor instead.

public class PathDescriptor
extends Object

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.

Author:

Henning P. Schmiedehausen

Constructor Summary

Constructors

Constructor and Description
PathDescriptor(String path) Deprecated. Construct a PathDescriptor from a path.
PathDescriptor(String base, String path) Deprecated. Construct a PathDescriptor from a path and a base.
PathDescriptor(URL baseUrl, String path) Deprecated. Construct a PathDescriptor from a path and a base.

Method Summary

Modifier and Type	Method and Description
URL	getBaseUrl() Deprecated. Get the base URL.
String	getLocation() Deprecated. Get the location for files.
String	getPath() Deprecated. Get the path.
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.
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(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 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 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