net.sf.mmm.util.resource.api

Class ResourcePathNode<D>

java.lang.Object

net.sf.mmm.util.resource.api.ResourcePathNode<D>

Type Parameters:

D - is the type of the generic data. For simple usage just Void.

All Implemented Interfaces:

Serializable, ResourcePath

Direct Known Subclasses:

ResourcePathNode.ResourcePathRootAbsolute, ResourcePathNode.ResourcePathRootHome, ResourcePathNode.ResourcePathRootRelative, ResourcePathNode.ResourcePathRootUnc, ResourcePathNode.ResourcePathRootUrl, ResourcePathNode.ResourcePathRootWindows

public class ResourcePathNode<D>
extends Object
implements ResourcePath, Serializable

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourcePathNode.ResourcePathRootAbsolute<D> Implementation of Unix/Linux absolute root.
static class	ResourcePathNode.ResourcePathRootHome<D> Implementation of home absolute root (~ or ~login).
static class	ResourcePathNode.ResourcePathRootRelative<D> Implementation of relative root.
static class	ResourcePathNode.ResourcePathRootUnc<D> Implementation of UNC absolute root.
static class	ResourcePathNode.ResourcePathRootUrl<D> Implementation of Unix/Linux absolute root.
static class	ResourcePathNode.ResourcePathRootWindows<D> Implementation of Windows absolute root drive.

Field Summary

Fields

Modifier and Type	Field and Description
private D	data
private static Function<ResourcePathNode<Pattern>,Pattern>	GLOB_PATTERN_FUNCTION The Void data function.
private String	name
private ResourcePathNode<D>	parent
static ResourcePathNode<Void>	ROOT_ABSOLUTE The absolute root ResourcePathNode (.).
static ResourcePathNode<Void>	ROOT_HOME The absolute home root ResourcePathNode (~).
static ResourcePathNode<Void>	ROOT_RELATIVE The relative root ResourcePathNode (/).
private static long	serialVersionUID
private static Function<ResourcePathNode<Void>,Void>	VOID_FUNCTION The Void data function.
private static char	WINDOWS_DRIVE_LETTER_SUFFIX The suffix of a Windows drive letter.

Fields inherited from interface net.sf.mmm.util.resource.api.ResourcePath

HOME_PATH_CHAR, PATH_SEGMENT_CURRENT_DIRECTORY, PATH_SEGMENT_PARENT_DIRECTORY, PATH_SEGMENT_SEPARATOR, PATH_SEGMENT_SEPARATOR_CHAR, UNC_PATH_PREFIX, URL_SCHEME_AUTHORITY_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourcePathNode(ResourcePathNode<D> parent, String name, D data) The constructor.
protected	ResourcePathNode(ResourcePathNode<D> parent, String name, Function<ResourcePathNode<D>,D> dataFunction) The constructor.
protected	ResourcePathNode(String name, Function<ResourcePathNode<D>,D> dataFunction) The constructor for a root ResourcePathNode.

Method Summary

Modifier and Type	Method and Description
List<ResourcePathNode<D>>	asList()
void	collectFromRoot(Collection<ResourcePathNode<D>> nodes) Adds all ResourcePathNodes of this path from the root down to this node.
static ResourcePathNode<Void>	create(String path) Creates a normalized ResourcePathNode.
static <D> ResourcePathNode<D>	create(String path, Function<ResourcePathNode<D>,D> dataFunction) Flexible implementation of create(String) to custom data function.
static ResourcePathNode<Pattern>	createPattern(String path) Calls create(String, Function) with data function delegating to WildcardGlobPatternCompiler.
private static <D> ResourcePathNode<D>	createRootPathSegment(CharSequenceScanner scanner, String originalPath, Function<ResourcePathNode<D>,D> dataFunction)
D	getData()
String	getName()
ResourcePathNode<D>	getParent()
ResourcePathNode<D>	getRoot()
boolean	isAbsolute()
protected boolean	isAppendSeparator()
boolean	isParentDirectory()
boolean	isRoot()
boolean	matches(ResourcePathNode<Pattern> patternPath) Checks if this ResourcePathNode matches to the given pattern path.
private ResourcePathNode<D>	navigateFrom(ResourcePathNode<D> resourcePath) Recursive and inverted implementation of navigateTo(ResourcePathNode).
ResourcePathNode<D>	navigateTo(ResourcePathNode<D> path)
private ResourcePathNode<D>	navigateUp()
String	toString()
String	toString(char separator)
protected void	toString(StringBuilder buffer, char separator)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

WINDOWS_DRIVE_LETTER_SUFFIX

private static final char WINDOWS_DRIVE_LETTER_SUFFIX

The suffix of a Windows drive letter.

See Also:

Constant Field Values

VOID_FUNCTION

private static final Function<ResourcePathNode<Void>,Void> VOID_FUNCTION

The Void data function.

GLOB_PATTERN_FUNCTION

private static final Function<ResourcePathNode<Pattern>,Pattern> GLOB_PATTERN_FUNCTION

The Void data function.

ROOT_ABSOLUTE

public static final ResourcePathNode<Void> ROOT_ABSOLUTE

The absolute root ResourcePathNode (.).

ROOT_RELATIVE

public static final ResourcePathNode<Void> ROOT_RELATIVE

The relative root ResourcePathNode (/).

ROOT_HOME

public static final ResourcePathNode<Void> ROOT_HOME

The absolute home root ResourcePathNode (~).

parent

private final ResourcePathNode<D> parent

name

private final String name

data

private final D data

Constructor Detail

ResourcePathNode

protected ResourcePathNode(String name,
                           Function<ResourcePathNode<D>,D> dataFunction)

The constructor for a root ResourcePathNode.

Parameters:

name - - see getName().

dataFunction - - the Function to create the data.

ResourcePathNode

protected ResourcePathNode(ResourcePathNode<D> parent,
                           String name,
                           D data)

The constructor.

Parameters:

parent - - see getParent().

name - - see getName().

data - - see getData().

ResourcePathNode

protected ResourcePathNode(ResourcePathNode<D> parent,
                           String name,
                           Function<ResourcePathNode<D>,D> dataFunction)

The constructor.

Parameters:

parent - - see getParent().

name - - see getName().

dataFunction - - the Function to create the data.

Method Detail

getParent

public ResourcePathNode<D> getParent()

Specified by:

getParent in interface ResourcePath

Returns:

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

getRoot

public ResourcePathNode<D> getRoot()

Specified by:

getRoot in interface ResourcePath

Returns:

the root ancestor of this ResourcePathNode.

getName

public String getName()

Specified by:

getName in interface ResourcePath

Returns:

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

getData

public D getData()

Returns:

the optional generic data. E.g. the name compiled as Pattern.

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface ResourcePath

Returns:

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

isParentDirectory

public boolean isParentDirectory()

Returns:

true if name is "..", false otherwise.

isRoot

public boolean isRoot()

Specified by:

isRoot in interface ResourcePath

Returns:

true if this is the root ResourcePathNode, false otherwise.

isAppendSeparator

protected boolean isAppendSeparator()

Returns:

true if toString(StringBuilder, char) needs to append a separator after this segment, false otherwise.

matches

public boolean matches(ResourcePathNode<Pattern> patternPath)

Checks if this ResourcePathNode matches to the given pattern path.

Parameters:

patternPath - the pattern path to match.

Returns:

true if this path matches the given the given patternPath.

collectFromRoot

public void collectFromRoot(Collection<ResourcePathNode<D>> nodes)

Adds all ResourcePathNodes of this path from the root down to this node.

Parameters:

nodes - is the Collection where to add the nodes.

asList

public List<ResourcePathNode<D>> asList()

Returns:

a List with all nodes from the root down to this node.

See Also:

collectFromRoot(Collection)

navigateTo

public ResourcePathNode<D> navigateTo(ResourcePathNode<D> path)

Parameters:

path - is the path to navigate to from this path.

Returns:

the given path if absolute, otherwise the normalized path of this path with the given path appended.

navigateUp

private ResourcePathNode<D> navigateUp()

Returns:

this instance if this is the root or is ResourcePath.PATH_SEGMENT_PARENT_DIRECTORY, the parent otherwise.

navigateFrom

private ResourcePathNode<D> navigateFrom(ResourcePathNode<D> resourcePath)

Recursive and inverted implementation of navigateTo(ResourcePathNode).

Parameters:

resourcePath - is the ResourcePathNode to navigate from.

Returns:

the resulting ResourcePathNode.

toString

protected void toString(StringBuilder buffer,
                        char separator)

Parameters:

buffer - is the StringBuilder where to append the string representation to.

separator - is the character to separate the ResourcePathNode segments. Typically .

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(char separator)

Parameters:

separator - is the character to separate the ResourcePathNode segments. Typically .

Returns:

the string representation.

create

public static ResourcePathNode<Void> create(String path)

Creates a normalized ResourcePathNode. Here are some examples:

path	ResourcePathNode.create(path)
	toString()	isAbsolute()	getName()
"/foo//bar/"	"/foo/bar"	true	"bar"
"/foo/bar"	"/foo/bar"	true	"bar"
"a/../b/./c"	"b/c"	false	"c"
"a/../../"	".."	false	".."
"a/.."	""	false	""
"../a"	"../a"	false	"a"
"/../a"	"/a"	true	"a"
"~/.ssh"	"~/.ssh"	true	".ssh"
"~admin/../"	"~admin/.."	true	".."
"/"	""	true	"/"
""	""	false	""
null	- (null)	- (null)	- (null)

Parameters:

path - is the path to parse (e.g. "/foo/bar.txt" or "a/../b/./c").

Returns:

the parsed path as ResourcePathNode or null if empty.

createPattern

public static ResourcePathNode<Pattern> createPattern(String path)

Calls create(String, Function) with data function delegating to WildcardGlobPatternCompiler.

Parameters:

path - - see create(String).

Returns:

the parsed ResourcePathNode.

See Also:

create(String), matches(ResourcePathNode)

create

public static <D> ResourcePathNode<D> create(String path,
                                             Function<ResourcePathNode<D>,D> dataFunction)

Flexible implementation of create(String) to custom data function.

Type Parameters:

D - is the type of the generic data. For simple usage just Void.

Parameters:

path - is the path to parse.

dataFunction - - the Function to create the data.

Returns:

the parsed path.

createRootPathSegment

private static <D> ResourcePathNode<D> createRootPathSegment(CharSequenceScanner scanner,
                                                             String originalPath,
                                                             Function<ResourcePathNode<D>,D> dataFunction)

Type Parameters:

D - is the type of the generic data. For simple usage just Void.

Parameters:

scanner - the fresh CharSequenceScanner for the entire path (normalized from of originalPath). Only the root segment shall be consumed.

originalPath - is the original path without normalization of slashed (may contain backslashes).

dataFunction - - the Function to create the data.

Returns:

the root path segment.

See Also:

create(String), isRoot()