Module com.github.robtimus.filesystems

Package com.github.robtimus.filesystems

Class AbstractPath

java.lang.Object

com.github.robtimus.filesystems.AbstractPath

All Implemented Interfaces:

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

Direct Known Subclasses:

SimpleAbstractPath

public abstract class AbstractPath
extends Object
implements Path

This class provides a skeletal implementation of the Path interface to minimize the effort required to implement this interface.

Author:

Rob Spoor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPath()	Creates a new path.

Method Summary

Modifier and Type	Method	Description
boolean	endsWith(String other)	Tests if this path ends with a Path, constructed by converting the given path string.
Path	getFileName()	Returns the name of the file or directory denoted by this path as a Path object.
Path	getName(int index)	Returns a name element of this path as a Path object.
Iterator<Path>	iterator()	Returns an iterator over the name elements of this path.
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>... events)	Registers the file located by this path with a watch service.
Path	resolve(String other)	Converts a given path string to a Path and resolves it against this Path.
Path	resolveSibling(String other)	Converts a given path string to a Path and resolves it against this path's parent path.
Path	resolveSibling(Path other)	Resolves the given path against this path's parent path.
boolean	startsWith(String other)	Tests if this path starts with a Path, constructed by converting the given path string.
File	toFile()	Returns a File object representing this path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.nio.file.Path

compareTo, endsWith, equals, getFileSystem, getNameCount, getParent, getRoot, hashCode, isAbsolute, normalize, register, relativize, resolve, startsWith, subpath, toAbsolutePath, toRealPath, toString, toUri

Constructor Detail

AbstractPath

protected AbstractPath()

Creates a new path.

Method Detail

getFileName

public Path getFileName()

Returns the name of the file or directory denoted by this path as a Path object.

This implementation returns getName(i), where i is equal to Path.getNameCount()- 1. If getNameCount() returns 0 this method returns null.

Specified by:

getFileName in interface Path

getName

public Path getName(int index)

Returns a name element of this path as a Path object.

This implementation calls subpath(index, index + 1).

Specified by:

getName in interface Path

startsWith

public boolean startsWith(String other)

Tests if this path starts with a Path, constructed by converting the given path string.

This implementation uses this path's FileSystem to convert the given string into a Path, then calls Path.startsWith(Path).

Specified by:

startsWith in interface Path

endsWith

public boolean endsWith(String other)

Tests if this path ends with a Path, constructed by converting the given path string.

This implementation uses this path's FileSystem to convert the given string into a Path, then calls Path.endsWith(Path).

Specified by:

endsWith in interface Path

resolve

public Path resolve(String other)

Converts a given path string to a Path and resolves it against this Path.

This implementation uses this path's FileSystem to convert the given string into a Path, then calls Path.resolve(Path).

Specified by:

resolve in interface Path

resolveSibling

public Path resolveSibling(String other)

Converts a given path string to a Path and resolves it against this path's parent path.

This implementation uses this path's FileSystem to convert the given string into a Path, then calls resolveSibling(Path).

Specified by:

resolveSibling in interface Path

resolveSibling

public Path resolveSibling(Path other)

Resolves the given path against this path's parent path.

This implementation returns getParent().resolve(other), or other if this path has no parent.

Specified by:

resolveSibling in interface Path

toFile

public File toFile()

Returns a File object representing this path.

This implementation will always throw an UnsupportedOperationException as per the contract of Path.toFile().

Specified by:

toFile in interface Path

register

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

Registers the file located by this path with a watch service.

This implementation will call Path.register(WatchService, WatchEvent.Kind[], WatchEvent.Modifier...) with an empty array of modifiers.

Specified by:

register in interface Path

Specified by:

register in interface Watchable

Throws:

IOException

iterator

public Iterator<Path> iterator()

Returns an iterator over the name elements of this path.

This implementation returns an iterator that uses Path.getNameCount() to determine whether or not there are more elements, and getName(int) to return the elements.

Specified by:

iterator in interface Iterable<Path>

Specified by:

iterator in interface Path