public final class CloudStoragePath implements Path
A Google Cloud Storage specific implementation of the java.nio.file.Path interface. An
instance of this class locates an object or a "pseudo-directory" in GCS. This implementation
allows one to use Java's standard file system API to deal with remote objects as if they are
local files.
Example of using java.nio.file.Files to read all lines from a remote object:
Path path = Paths.get(URI.create("gs://bucket/lolcat.csv"));
List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8);
Inheritance
Object >
CloudStoragePath
Methods
bucket()
Returns the Cloud Storage bucket name being served by this file system.
| Returns |
| Type |
Description |
String |
|
compareTo(Path other)
public int compareTo(Path other)
| Parameter |
| Name |
Description |
other |
Path
|
| Returns |
| Type |
Description |
int |
|
endsWith(String other)
public boolean endsWith(String other)
| Parameter |
| Name |
Description |
other |
String
|
endsWith(Path other)
public boolean endsWith(Path other)
| Parameter |
| Name |
Description |
other |
Path
|
equals(Object other)
public boolean equals(Object other)
| Parameter |
| Name |
Description |
other |
Object
|
Overrides
getFileName()
public CloudStoragePath getFileName()
getFileSystem()
public CloudStorageFileSystem getFileSystem()
getName(int index)
public CloudStoragePath getName(int index)
| Parameter |
| Name |
Description |
index |
int
|
getNameCount()
public int getNameCount()
| Returns |
| Type |
Description |
int |
|
getParent()
public CloudStoragePath getParent()
getRoot()
public CloudStoragePath getRoot()
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
isAbsolute()
public boolean isAbsolute()
iterator()
public Iterator<Path> iterator()
normalize()
public CloudStoragePath normalize()
Returns path without extra slashes or . and .. and preserves trailing slash.
register(WatchService watcher, WatchEvent.Kind<?>[] events)
public WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events)
register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier[] modifiers)
public WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier[] modifiers)
| Parameters |
| Name |
Description |
watcher |
WatchService
|
events |
Kind<?>[]
|
modifiers |
java.nio.file.WatchEvent.Modifier[]
|
relativize(Path object)
public CloudStoragePath relativize(Path object)
| Parameter |
| Name |
Description |
object |
Path
|
resolve(String other)
public CloudStoragePath resolve(String other)
| Parameter |
| Name |
Description |
other |
String
|
resolve(Path object)
public CloudStoragePath resolve(Path object)
| Parameter |
| Name |
Description |
object |
Path
|
resolveSibling(String other)
public CloudStoragePath resolveSibling(String other)
| Parameter |
| Name |
Description |
other |
String
|
resolveSibling(Path other)
public CloudStoragePath resolveSibling(Path other)
| Parameter |
| Name |
Description |
other |
Path
|
startsWith(String other)
public boolean startsWith(String other)
| Parameter |
| Name |
Description |
other |
String
|
startsWith(Path other)
public boolean startsWith(Path other)
| Parameter |
| Name |
Description |
other |
Path
|
subpath(int beginIndex, int endIndex)
public CloudStoragePath subpath(int beginIndex, int endIndex)
| Parameters |
| Name |
Description |
beginIndex |
int
|
endIndex |
int
|
toAbsolutePath()
public CloudStoragePath toAbsolutePath()
toFile()
| Returns |
| Type |
Description |
File |
|
toRealPath(LinkOption[] options)
public CloudStoragePath toRealPath(LinkOption[] options)
Returns this path rewritten to the Cloud Storage object name that'd be used to perform i/o.
This method makes path absolute and removes the prefix slash from
the absolute path when stripPrefixSlash is
true.
| Parameter |
| Name |
Description |
options |
java.nio.file.LinkOption[]
|
toString()
| Returns |
| Type |
Description |
String |
|
Overrides
toUri()
| Returns |
| Type |
Description |
URI |
|
