ch.pontius.nio.smb

Class SMBPath

java.lang.Object

ch.pontius.nio.smb.SMBPath

All Implemented Interfaces:

Comparable<Path>, Iterable<Path>, Path, Watchable

public final class SMBPath
extends Object
implements Path

A Path implementation that can be used with SMBNio

Version:

1.1

Author:

Ralph Gasser

Method Summary

Modifier and Type	Method and Description
int	compareTo(Path other) Compares two abstract paths lexicographically.
boolean	endsWith(Path other) Tests if this path ends with the given path.
boolean	endsWith(String other) Tests if this path ends with the provided string.
boolean	equals(Object other) Tests this path for equality with the given object.
Path	getFileName() Returns a new, relative SMBPath instance that just contains the last path component of the current SMBPath's path.
FileSystem	getFileSystem() Getter for SMBFileSystem this SMBPath belongs to.
Path	getName(int index) Returns a name element of this SMBPath as a new SMBPath object.
int	getNameCount() Returns the number of path components in the current SMBPath's path.
Path	getParent() Returns a new SMBPath that points to the parent of the current SMBPath.
Path	getRoot() Returns the root component of this SMBPath or null, if the path is relative.
boolean	isAbsolute() SMBPath is always absolute!
boolean	isFolder() Checks whether the current SMBPath is a folder.
Iterator<Path>	iterator() Returns an iterator over the name elements of this SMBPath.
Path	normalize() Returns a path that is this path with redundant name elements, like "." or ".." eliminated.
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>... events)
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers)
Path	relativize(Path other) Constructs a relative path between this path and a given path.
Path	resolve(Path other) Resolve the given path against this SMBPath.
Path	resolve(String other) Resolve the given path string against this SMBPath.
Path	resolveSibling(Path other) Resolve the given path against this SMBPath's parent.
Path	resolveSibling(String other) Resolve the given path string against this SMBPath.
boolean	startsWith(Path other) Tests if this path starts with the given path.
boolean	startsWith(String other) Tests if this path starts with the provided string.
Path	subpath(int beginIndex, int endIndex) Returns a relative Path that is a subsequence of the name elements of this path.
Path	toAbsolutePath() If this SMBPath is absolute then the method returns this.
File	toFile()
Path	toRealPath(LinkOption... options)
String	toString() Default toString() method.
URI	toUri() Returns a URI to represent this SMBPath.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.file.Path

hashCode

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getFileSystem

public final FileSystem getFileSystem()

Getter for SMBFileSystem this SMBPath belongs to.

Specified by:

getFileSystem in interface Path

Returns:

SMBFileSystem

isAbsolute

public final boolean isAbsolute()

SMBPath is always absolute!

Specified by:

isAbsolute in interface Path

Returns:

true

getRoot

public Path getRoot()

Returns the root component of this SMBPath or null, if the path is relative.

Specified by:

getRoot in interface Path

Returns:

Root component of this SMBPath

getFileName

public Path getFileName()

Returns a new, relative SMBPath instance that just contains the last path component of the current SMBPath's path.

Specified by:

getFileName in interface Path

Returns:

SMBPath for the file name.

getParent

public Path getParent()

Returns a new SMBPath that points to the parent of the current SMBPath. If the current SMBPath instance does not have a parent, this method returns null.

Specified by:

getParent in interface Path

Returns:

Parent SMBPath.

getNameCount

public int getNameCount()

Returns the number of path components in the current SMBPath's path.

Specified by:

getNameCount in interface Path

Returns:

Number of path components.

getName

public Path getName(int index)

Returns a name element of this SMBPath as a new SMBPath object. The index parameter is the index of the name element to return. The element that is closest to the root in the directory hierarchy has index 0. The element that is farthest from the root has index count-1.

Specified by:

getName in interface Path

Parameters:

index - The index of the element

Returns:

The name element.

subpath

public Path subpath(int beginIndex,
                    int endIndex)

Returns a relative Path that is a subsequence of the name elements of this path.

Specified by:

subpath in interface Path

Parameters:

beginIndex - The index of the first element, inclusive

endIndex - The index of the last element, exclusive

Returns:

The resulting subpath.

Throws:

IllegalArgumentException - If beginIndex is negative, or greater than or equal to the number of elements. If endIndex is less than or equal to beginIndex, or larger than the number of elements.

startsWith

public boolean startsWith(Path other)

Tests if this path starts with the given path. If the two paths belong to a different FileSystem then this method always returns false. Otherwise, a string comparison is performed.

Specified by:

startsWith in interface Path

Parameters:

other - The given path

Returns:

True if this path starts with the given path; otherwise false

startsWith

public boolean startsWith(String other)

Tests if this path starts with the provided string. The path separators will be taken into account.

Specified by:

startsWith in interface Path

Parameters:

other - The given path

Returns:

True if this path starts with the given string; otherwise false

endsWith

public boolean endsWith(Path other)

Tests if this path ends with the given path. If the two paths belong to a different FileSystem then this method always returns false. Otherwise, a string comparison is performed.

Specified by:

endsWith in interface Path

Parameters:

other - The given path

Returns:

True if this path starts with the given path; otherwise false

endsWith

public boolean endsWith(String other)

Tests if this path ends with the provided string. The path separators will be taken into account.

Specified by:

endsWith in interface Path

Parameters:

other - The given path

Returns:

True if this path starts with the given string; otherwise false

normalize

public Path normalize()

Returns a path that is this path with redundant name elements, like "." or ".." eliminated.

Specified by:

normalize in interface Path

Returns:

Normalized SMBPath.

resolve

public Path resolve(Path other)

Resolve the given path against this SMBPath. If the other parameter is an absolute path then this method trivially returns other. If other is an empty path then this method trivially returns this path.

Specified by:

resolve in interface Path

Parameters:

other - The path to resolve against this path

Returns:

The resulting SMBPath

Throws:

IllegalArgumentException - If other path is not a SMBPath OR does not belong to the same SMBFileSystem OR if this path points to a file.

resolve

public Path resolve(String other)

Resolve the given path string against this SMBPath. If the other parameter is an absolute path then this method trivially returns other. If other is an empty path then this method trivially returns this path.

Specified by:

resolve in interface Path

Parameters:

other - The path to resolve against this path

Returns:

The resulting SMBPath

Throws:

IllegalArgumentException - If other path is not a SMBPath OR does not belong to the same SMBFileSystem OR if this path points to a file.

resolveSibling

public Path resolveSibling(Path other)

Resolve the given path against this SMBPath's parent. If the other parameter is an absolute path then this method trivially returns other. If other is an empty path then this method trivially returns this path.

Specified by:

resolveSibling in interface Path

Parameters:

other - The path to resolve against this path

Returns:

The resulting SMBPath

Throws:

IllegalArgumentException - If other path is not a SMBPath OR does not belong to the same SMBFileSystem.

resolveSibling

public Path resolveSibling(String other)

Resolve the given path string against this SMBPath. If the other parameter is an absolute path then this method trivially returns other. If other is an empty path then this method trivially returns this path.

Specified by:

resolveSibling in interface Path

Parameters:

other - The path to resolve against this path

Returns:

The resulting SMBPath

Throws:

IllegalArgumentException - If other path is not a SMBPath OR does not belong to the same SMBFileSystem OR if this path points to a file.

relativize

public Path relativize(Path other)

Constructs a relative path between this path and a given path.

Specified by:

relativize in interface Path

Parameters:

other - The other path.

Throws:

IllegalArgumentException - If other path is not a SMBPath OR does not belong to the same SMBFileSystem OR if this path points to a file.

toUri

public URI toUri()

Returns a URI to represent this SMBPath.

Specified by:

toUri in interface Path

Returns:

The URI representing this path

toAbsolutePath

public Path toAbsolutePath()

If this SMBPath is absolute then the method returns this. Otherwise, the given path is resolved against the top-level directory.

Specified by:

toAbsolutePath in interface Path

Returns:

Absolute SMBPath

iterator

public Iterator<Path> iterator()

Returns an iterator over the name elements of this SMBPath. The first element returned by the iterator represents the name element that is closest to the root in the directory hierarchy, the second element is the next closest, and so on. The last element returned is the name of the file or directory denoted by this path. The root component, if present, is not returned by the iterator.

Specified by:

iterator in interface Iterable<Path>

Specified by:

iterator in interface Path

Returns:

An iterator over the name elements of this path.

compareTo

public int compareTo(Path other)

Compares two abstract paths lexicographically. This method does not access the file system and neither file is required to exist.

Specified by:

compareTo in interface Comparable<Path>

Specified by:

compareTo in interface Path

Parameters:

other - The path compared to this SMBPath.

Returns:

Zero if the argument is equal to this path, a value less than zero if this path is lexicographically less than the argument, or a value greater than zero if this path is lexicographically greater than the argument

toString

public String toString()

Default toString() method.

Specified by:

toString in interface Path

Overrides:

toString in class Object

Returns:

String representation of SMBPath.

equals

public boolean equals(Object other)

Tests this path for equality with the given object. If the given object is not a SMBPath, or is a SMBPath associated with a different SMBFileSystem, then this method returns false.

Specified by:

equals in interface Path

Overrides:

equals in class Object

Parameters:

other - The object to which this object is to be compared

Returns:

If, and only if, the given object is a SMBPath that is identical to this SMBPath.

isFolder

public boolean isFolder()

Checks whether the current SMBPath is a folder.

Returns:

True if current SMBPath is a folder.

toFile

public File toFile()

Specified by:

toFile in interface Path

toRealPath

public Path toRealPath(LinkOption... options)
                throws IOException

Specified by:

toRealPath in interface Path

Throws:

IOException

register

public WatchKey register(WatchService watcher,
                         WatchEvent.Kind<?>[] events,
                         WatchEvent.Modifier... modifiers)
                  throws IOException

Specified by:

register in interface Path

Specified by:

register in interface Watchable

Throws:

IOException

register

public WatchKey register(WatchService watcher,
                         WatchEvent.Kind<?>... events)
                  throws IOException

Specified by:

register in interface Path

Specified by:

register in interface Watchable

Throws:

IOException