Class JimfsPath

java.lang.Object

com.google.common.jimfs.JimfsPath

All Implemented Interfaces:

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

final class JimfsPath
extends Object
implements Path

Jimfs implementation of Path. Creation of new Path objects is delegated to the file system's PathService.

Field Summary

Fields

Modifier and Type	Field	Description
private final com.google.common.collect.ImmutableList<Name>	names
private final PathService	pathService
private final @Nullable Name	root

Constructor Summary

Constructors

Constructor	Description
JimfsPath(PathService pathService, @Nullable Name root, Iterable<Name> names)

Method Summary

Modifier and Type	Method	Description
private List<Path>	asList()
private @Nullable JimfsPath	checkPath(Path other)
int	compareTo(Path other)
boolean	endsWith(String other)
boolean	endsWith(Path other)
boolean	equals(@Nullable Object obj)
@Nullable JimfsPath	getFileName()
FileSystem	getFileSystem()
JimfsFileSystem	getJimfsFileSystem()	Equivalent to getFileSystem() but with a return type of JimfsFileSystem.
JimfsPath	getName(int index)
int	getNameCount()
@Nullable JimfsPath	getParent()
@Nullable JimfsPath	getRoot()
int	hashCode()
boolean	isAbsolute()
boolean	isEmptyPath()	Returns whether or not this is the empty path, with no root and a single, empty string, name.
private boolean	isNormal()	Returns whether or not this path is in a normalized form.
Iterator<Path>	iterator()
@Nullable Name	name()	Returns the file name of this path.
com.google.common.collect.ImmutableList<Name>	names()	Returns the list of name elements.
JimfsPath	normalize()
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>... events)
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers)
JimfsPath	relativize(Path other)
(package private) JimfsPath	resolve(Name name)	Resolves the given name against this path.
JimfsPath	resolve(String other)
JimfsPath	resolve(Path other)
JimfsPath	resolveSibling(String other)
JimfsPath	resolveSibling(Path other)
@Nullable Name	root()	Returns the root name, or null if there is no root.
boolean	startsWith(String other)
boolean	startsWith(Path other)
private static boolean	startsWith(List<?> list, List<?> other)	Returns true if list starts with all elements of other in the same order.
JimfsPath	subpath(int beginIndex, int endIndex)
JimfsPath	toAbsolutePath()
File	toFile()
JimfsPath	toRealPath(LinkOption... options)
String	toString()
URI	toUri()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Path

resolve, resolve

Field Details

root

private final @Nullable Name root

names

private final com.google.common.collect.ImmutableList<Name> names

pathService

private final PathService pathService

Constructor Details

JimfsPath

public JimfsPath(PathService pathService,
 @Nullable Name root,
 Iterable<Name> names)

Method Details

root

public @Nullable Name root()

Returns the root name, or null if there is no root.

names

public com.google.common.collect.ImmutableList<Name> names()

Returns the list of name elements.

name

public @Nullable Name name()

Returns the file name of this path. Unlike getFileName(), this may return the name of the root if this is a root path.

isEmptyPath

public boolean isEmptyPath()

Returns whether or not this is the empty path, with no root and a single, empty string, name.

getFileSystem

public FileSystem getFileSystem()

Specified by:

getFileSystem in interface Path

getJimfsFileSystem

public JimfsFileSystem getJimfsFileSystem()

Equivalent to getFileSystem() but with a return type of JimfsFileSystem. getFileSystem()'s return type is left as FileSystem to make testing paths easier (as long as methods that access the file system in some way are not called, the file system can be a fake file system instance).

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface Path

getRoot

public @Nullable JimfsPath getRoot()

Specified by:

getRoot in interface Path

getFileName

public @Nullable JimfsPath getFileName()

Specified by:

getFileName in interface Path

getParent

public @Nullable JimfsPath getParent()

Specified by:

getParent in interface Path

getNameCount

public int getNameCount()

Specified by:

getNameCount in interface Path

getName

public JimfsPath getName(int index)

Specified by:

getName in interface Path

subpath

public JimfsPath subpath(int beginIndex,
 int endIndex)

Specified by:

subpath in interface Path

startsWith

private static boolean startsWith(List<?> list,
 List<?> other)

Returns true if list starts with all elements of other in the same order.

startsWith

public boolean startsWith(Path other)

Specified by:

startsWith in interface Path

startsWith

public boolean startsWith(String other)

Specified by:

startsWith in interface Path

endsWith

public boolean endsWith(Path other)

Specified by:

endsWith in interface Path

endsWith

public boolean endsWith(String other)

Specified by:

endsWith in interface Path

normalize

public JimfsPath normalize()

Specified by:

normalize in interface Path

isNormal

private boolean isNormal()

Returns whether or not this path is in a normalized form. It's normal if it both contains no "." names and contains no ".." names in a location other than the start of the path.

resolve

JimfsPath resolve(Name name)

Resolves the given name against this path. The name is assumed not to be a root name.

resolve

public JimfsPath resolve(Path other)

Specified by:

resolve in interface Path

resolve

public JimfsPath resolve(String other)

Specified by:

resolve in interface Path

resolveSibling

public JimfsPath resolveSibling(Path other)

Specified by:

resolveSibling in interface Path

resolveSibling

public JimfsPath resolveSibling(String other)

Specified by:

resolveSibling in interface Path

relativize

public JimfsPath relativize(Path other)

Specified by:

relativize in interface Path

toAbsolutePath

public JimfsPath toAbsolutePath()

Specified by:

toAbsolutePath in interface Path

toRealPath

public JimfsPath 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

toUri

public URI toUri()

Specified by:

toUri in interface Path

toFile

public File toFile()

Specified by:

toFile in interface Path

iterator

public Iterator<Path> iterator()

Specified by:

iterator in interface Iterable<Path>

Specified by:

iterator in interface Path

asList

private List<Path> asList()

compareTo

public int compareTo(Path other)

Specified by:

compareTo in interface Comparable<Path>

Specified by:

compareTo in interface Path

equals

public boolean equals(@Nullable Object obj)

Specified by:

equals in interface Path

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Path

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface Path

Overrides:

toString in class Object

checkPath

private @Nullable JimfsPath checkPath(Path other)