CloudStoragePath (Google Cloud NIO 0.124.11 API)

java.lang.Object
- com.google.cloud.storage.contrib.nio.CloudStoragePath

All Implemented Interfaces:

Comparable<Path>, Iterable<Path>, Path, Watchable
```
@Immutable
public final class CloudStoragePath
extends Object
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);
 
```

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bucket()` Returns the Cloud Storage bucket name being served by this file system.
`int`	`compareTo(Path other)`
`boolean`	`endsWith(Path other)`
`boolean`	`endsWith(String other)`
`boolean`	`equals(Object other)`
`CloudStoragePath`	`getFileName()`
`CloudStorageFileSystem`	`getFileSystem()`
`CloudStoragePath`	`getName(int index)`
`int`	`getNameCount()`
`CloudStoragePath`	`getParent()`
`CloudStoragePath`	`getRoot()`
`int`	`hashCode()`
`boolean`	`isAbsolute()`
`Iterator<Path>`	`iterator()`
`CloudStoragePath`	`normalize()` Returns path without extra slashes or `.` and `..` and preserves trailing slash.
`WatchKey`	`register(WatchService watcher, WatchEvent.Kind<?>... events)` Throws `UnsupportedOperationException` because this feature hasn't been implemented yet.
`WatchKey`	`register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers)` Throws `UnsupportedOperationException` because this feature hasn't been implemented yet.
`CloudStoragePath`	`relativize(Path object)`
`CloudStoragePath`	`resolve(Path object)`
`CloudStoragePath`	`resolve(String other)`
`CloudStoragePath`	`resolveSibling(Path other)`
`CloudStoragePath`	`resolveSibling(String other)`
`boolean`	`startsWith(Path other)`
`boolean`	`startsWith(String other)`
`CloudStoragePath`	`subpath(int beginIndex, int endIndex)`
`CloudStoragePath`	`toAbsolutePath()` Changes relative path to be absolute, using `workingDirectory` as current dir.
`File`	`toFile()` Throws `UnsupportedOperationException` because Google Cloud Storage files are not backed by the local file system.
`CloudStoragePath`	`toRealPath(LinkOption... options)` Returns this path rewritten to the Cloud Storage object name that'd be used to perform i/o.
`String`	`toString()`
`URI`	`toUri()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - bucket
```
public String bucket()
```
    Returns the Cloud Storage bucket name being served by this file system.
  - getFileSystem
```
public CloudStorageFileSystem getFileSystem()
```
    Specified by:
    
    getFileSystem in interface Path
  - getRoot
```
@Nullable
public CloudStoragePath getRoot()
```
    Specified by:
    
    getRoot in interface Path
  - isAbsolute
```
public boolean isAbsolute()
```
    Specified by:
    
    isAbsolute in interface Path
  - toAbsolutePath
```
public CloudStoragePath toAbsolutePath()
```
    Changes relative path to be absolute, using workingDirectory as current dir.
    
    Specified by:
    
    toAbsolutePath in interface Path
  - toRealPath
```
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.
    
    Specified by:
    
    toRealPath in interface Path
    
    Throws:
    
    IllegalArgumentException - if path contains extra slashes or dot-dirs when permitEmptyPathComponents is false, or if the resulting path is empty.
  - normalize
```
public CloudStoragePath normalize()
```
    Returns path without extra slashes or . and .. and preserves trailing slash.
    
    Specified by:
    
    normalize in interface Path
  - resolve
```
public CloudStoragePath resolve(Path object)
```
    Specified by:
    
    resolve in interface Path
  - resolve
```
public CloudStoragePath resolve(String other)
```
    Specified by:
    
    resolve in interface Path
  - resolveSibling
```
public CloudStoragePath resolveSibling(Path other)
```
    Specified by:
    
    resolveSibling in interface Path
  - resolveSibling
```
public CloudStoragePath resolveSibling(String other)
```
    Specified by:
    
    resolveSibling in interface Path
  - relativize
```
public CloudStoragePath relativize(Path object)
```
    Specified by:
    
    relativize in interface Path
  - getParent
```
@Nullable
public CloudStoragePath getParent()
```
    Specified by:
    
    getParent in interface Path
  - getFileName
```
@Nullable
public CloudStoragePath getFileName()
```
    Specified by:
    
    getFileName in interface Path
  - subpath
```
public CloudStoragePath subpath(int beginIndex,
                                int endIndex)
```
    Specified by:
    
    subpath in interface Path
  - getNameCount
```
public int getNameCount()
```
    Specified by:
    
    getNameCount in interface Path
  - getName
```
public CloudStoragePath getName(int index)
```
    Specified by:
    
    getName in interface Path
  - 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
  - register
```
public WatchKey register(WatchService watcher,
                         WatchEvent.Kind<?>[] events,
                         WatchEvent.Modifier... modifiers)
```
    Throws UnsupportedOperationException because this feature hasn't been implemented yet.
    
    Specified by:
    
    register in interface Path
    
    Specified by:
    
    register in interface Watchable
  - register
```
public WatchKey register(WatchService watcher,
                         WatchEvent.Kind<?>... events)
```
    Throws UnsupportedOperationException because this feature hasn't been implemented yet.
    
    Specified by:
    
    register in interface Path
    
    Specified by:
    
    register in interface Watchable
  - toFile
```
public File toFile()
```
    Throws UnsupportedOperationException because Google Cloud Storage files are not backed by the local file system.
    
    Specified by:
    
    toFile in interface Path
  - iterator
```
public Iterator<Path> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Path>
    
    Specified by:
    
    iterator in interface Path
  - compareTo
```
public int compareTo(Path other)
```
    Specified by:
    
    compareTo in interface Comparable<Path>
    
    Specified by:
    
    compareTo in interface Path
  - equals
```
public boolean equals(Object other)
```
    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
  - toUri
```
public URI toUri()
```
    Specified by:
    
    toUri in interface Path

Class CloudStoragePath

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

bucket

getFileSystem

getRoot

isAbsolute

toAbsolutePath

toRealPath

normalize

resolve

resolve

resolveSibling

resolveSibling

relativize

getParent

getFileName

subpath

getNameCount

getName

startsWith

startsWith

endsWith

endsWith

register

register

toFile

iterator

compareTo

equals

hashCode

toString

toUri