net.sf.mmm.util.resource.api

Interface ResourcePath

All Known Implementing Classes:

AbstractBrowsableClasspathResource, ClasspathFile, ClasspathFolder, ResourcePathNode, ResourcePathNode.ResourcePathRootAbsolute, ResourcePathNode.ResourcePathRootHome, ResourcePathNode.ResourcePathRootRelative, ResourcePathNode.ResourcePathRootUnc, ResourcePathNode.ResourcePathRootUrl, ResourcePathNode.ResourcePathRootWindows

public interface ResourcePath

This class represents a path in a file, URL, or the like.

Since:

7.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

ResourcePathNode.create(String)

Field Summary

Fields

Modifier and Type	Field and Description
static char	HOME_PATH_CHAR The path segment separator.
static String	PATH_SEGMENT_CURRENT_DIRECTORY The path segment indicating the current folder itself.
static String	PATH_SEGMENT_PARENT_DIRECTORY The path segment indicating the parent folder.
static String	PATH_SEGMENT_SEPARATOR The path segment separator.
static char	PATH_SEGMENT_SEPARATOR_CHAR The path segment separator.
static String	UNC_PATH_PREFIX The prefix of an UNC (Uniform Naming Convention) path (e.g.
static String	URL_SCHEME_AUTHORITY_SEPARATOR The separator infix between scheme and authority in an URL.

Method Summary

Modifier and Type	Method and Description
String	getName()
ResourcePath	getParent()
ResourcePath	getRoot()
boolean	isAbsolute()
boolean	isRoot()

Field Detail

PATH_SEGMENT_CURRENT_DIRECTORY

static final String PATH_SEGMENT_CURRENT_DIRECTORY

The path segment indicating the current folder itself.

See Also:

Constant Field Values

PATH_SEGMENT_PARENT_DIRECTORY

static final String PATH_SEGMENT_PARENT_DIRECTORY

The path segment indicating the parent folder.

See Also:

Constant Field Values

PATH_SEGMENT_SEPARATOR_CHAR

static final char PATH_SEGMENT_SEPARATOR_CHAR

The path segment separator.

See Also:

Constant Field Values

PATH_SEGMENT_SEPARATOR

static final String PATH_SEGMENT_SEPARATOR

The path segment separator.

HOME_PATH_CHAR

static final char HOME_PATH_CHAR

The path segment separator.

See Also:

Constant Field Values

UNC_PATH_PREFIX

static final String UNC_PATH_PREFIX

The prefix of an UNC (Uniform Naming Convention) path (e.g. \\10.0.0.1\share).

See Also:

Constant Field Values

URL_SCHEME_AUTHORITY_SEPARATOR

static final String URL_SCHEME_AUTHORITY_SEPARATOR

The separator infix between scheme and authority in an URL.

See Also:

Constant Field Values

Method Detail

getParent

ResourcePath getParent()

Returns:

the parent ResourcePathNode or null if this is the isRoot() segment.

getRoot

ResourcePath getRoot()

Returns:

the root ancestor of this ResourcePathNode.

getName

String getName()

Returns:

the name of this ResourcePathNode as segment (this "folder" or "file").

isAbsolute

boolean isAbsolute()

Returns:

true if this path is absolute, false if it is relative.

isRoot

boolean isRoot()

Returns:

true if this is the root ResourcePathNode, false otherwise.