ca.uqac.lif.fs

Class FilePath

java.lang.Object

ca.uqac.lif.fs.FilePath

public class FilePath
extends java.lang.Object

Representation of a path to a file in a file system. This class works in a similar way as Java's built-in Path class. The main difference is that a FilePath supports the ".." relative path element (representing a move up in the directory hierarchy). A file path is immutable; all instances that modify a path return a new path instance.

Author:

Sylvain Hallé

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOT The character sequence used to designate the current directory.
protected boolean	m_isAbsolute A flag that determines if the path is absolute.
protected java.util.List<java.lang.String>	m_parts The elements of the path.
static java.lang.String	SLASH The character used to separate path parts.
static java.lang.String	UP The character sequence used to designate the "up" direction.

Constructor Summary

Constructors

Constructor and Description
FilePath(java.util.List<java.lang.String> parts, boolean is_absolute) Creates a file path from a list of path elements.
FilePath(java.lang.String path) Creates a file path by parsing a string.

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	asPath() Produces a Java Path object corresponding to the current file path.
FilePath	chdir(FilePath path) Obtains a path instance relative to the current path.
FilePath	chdir(java.lang.String path) Obtains a path instance relative to the current path.
static java.util.List<java.lang.String>	fragment(java.lang.String path) Splits a string into path fragments according to the path separator.
boolean	isAbsolute() Determines if this path is an absolute path.
static java.util.List<java.lang.String>	simplify(java.util.List<java.lang.String> parts) Simplifies a list of path parts.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SLASH

public static final java.lang.String SLASH

The character used to separate path parts.

See Also:

Constant Field Values

UP

public static final java.lang.String UP

The character sequence used to designate the "up" direction.

See Also:

Constant Field Values

DOT

public static final java.lang.String DOT

The character sequence used to designate the current directory.

See Also:

Constant Field Values

m_parts

protected final java.util.List<java.lang.String> m_parts

The elements of the path.

m_isAbsolute

protected final boolean m_isAbsolute

A flag that determines if the path is absolute.

Constructor Detail

FilePath

public FilePath(java.util.List<java.lang.String> parts,
                boolean is_absolute)

Creates a file path from a list of path elements.

Parameters:

parts - The list of path elements

is_absolute - A flag indicating if the path is an absolute one

FilePath

public FilePath(java.lang.String path)

Creates a file path by parsing a string.

Parameters:

path - The string containing the path

Method Detail

isAbsolute

public boolean isAbsolute()

Determines if this path is an absolute path.

Returns:

true if the path is absolute, false otherwise

chdir

public FilePath chdir(FilePath path)

Obtains a path instance relative to the current path.

Parameters:

path - A string corresponding to the path relative to the current path

Returns:

The new file path instance

chdir

public FilePath chdir(java.lang.String path)

Obtains a path instance relative to the current path.

Parameters:

path - A string corresponding to the path relative to the current path

Returns:

The new file path instance

asPath

public java.nio.file.Path asPath()

Produces a Java Path object corresponding to the current file path.

Returns:

The path object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fragment

public static java.util.List<java.lang.String> fragment(java.lang.String path)

Splits a string into path fragments according to the path separator. Any path fragment that is empty, or is only made of whitespace, is ignored.

Parameters:

path - The string

Returns:

The path fragments

simplify

public static java.util.List<java.lang.String> simplify(java.util.List<java.lang.String> parts)

Simplifies a list of path parts.

Parameters:

parts - The list of parts

Returns:

The simplified list