Class PathDescriptor
java.lang.Object
org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
Deprecated.
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
ConstructorsConstructorDescriptionPathDescriptor
(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 TypeMethodDescriptionDeprecated.Get the base URL.Deprecated.Get the location for files.getPath()
Deprecated.Get the path.Deprecated.Get the path as a URL.boolean
isFile()
Deprecated.Check if this PathDescriptor describes a file.boolean
Deprecated.Check if this PathDescriptor describes a relative path.toString()
Deprecated.
-
Constructor Details
-
PathDescriptor
Deprecated.Construct a PathDescriptor from a path.- Parameters:
path
- the path.- Throws:
MalformedURLException
- if a URL cannot be formed from the path.
-
PathDescriptor
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
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
-
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
Deprecated.Get the base URL.- Returns:
- the base URL.
-
getPathUrl
Deprecated.Get the path as a URL.- Returns:
- the path as a URL.
-
getPath
Deprecated.Get the path.- Returns:
- the path.
-
getLocation
Deprecated.Get the location for files.- Returns:
- the location.
-
toString
Deprecated.
-
URIPathDescriptor
instead.