S3Path (s3fs 2.2.3 API)

java.lang.Object
- com.upplication.s3fs.S3Path

All Implemented Interfaces:

Comparable<Path>, Iterable<Path>, Path, Watchable
```
public class S3Path
extends Object
implements Path
```

Field Summary

Fields
Modifier and Type Field and Description

static String PATH_SEPARATOR

Fields
Modifier and Type	Field and Description
`static String`	`PATH_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description

S3Path(S3FileSystem fileSystem, String first, String... more)
Build an S3Path from path segments.

Constructors
Constructor and Description
`S3Path(S3FileSystem fileSystem, String first, String... more)` Build an S3Path from path segments.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Path other)`
`boolean`	`endsWith(Path other)`
`boolean`	`endsWith(String other)`
`boolean`	`equals(Object o)`
`S3BasicFileAttributes`	`getFileAttributes()`
`Path`	`getFileName()`
`S3FileStore`	`getFileStore()`
`S3FileSystem`	`getFileSystem()`
`String`	`getKey()` key for amazon without final slash.
`Path`	`getName(int index)`
`int`	`getNameCount()`
`Path`	`getParent()`
`Path`	`getRoot()`
`int`	`hashCode()`
`boolean`	`isAbsolute()`
`Iterator<Path>`	`iterator()`
`Path`	`normalize()`
`WatchKey`	`register(WatchService watcher, WatchEvent.Kind<?>... events)`
`WatchKey`	`register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers)`
`Path`	`relativize(Path other)`
`Path`	`resolve(Path other)`
`Path`	`resolve(String other)`
`Path`	`resolveSibling(Path other)`
`Path`	`resolveSibling(String other)`
`void`	`setFileAttributes(S3BasicFileAttributes fileAttributes)`
`boolean`	`startsWith(Path other)`
`boolean`	`startsWith(String path)`
`Path`	`subpath(int beginIndex, int endIndex)` The bucket name not count
`Path`	`toAbsolutePath()`
`File`	`toFile()`
`Path`	`toRealPath(LinkOption... options)`
`String`	`toString()`
`URI`	`toUri()` Examples: Relative: -------- NO use fileSystem and not used fileStore.
`URL`	`toURL()` Get the url for the s3Path.

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

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

- Field Detail
  - PATH_SEPARATOR
```
public static final String PATH_SEPARATOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - S3Path
```
public S3Path(S3FileSystem fileSystem,
              String first,
              String... more)
```
    Build an S3Path from path segments. '/' are stripped from each segment.
    
    Parameters:
    
    fileSystem - S3FileSystem
    
    first - should be start with a '/' and is the bucket name
    
    more - directories and files
- Method Detail
  - getFileStore
```
public S3FileStore getFileStore()
```
  - getKey
```
public String getKey()
```
    key for amazon without final slash. note: the final slash need to be added to save a directory (Amazon s3 spec)
    
    Returns:
    
    the key for AmazonS3Client
  - getFileSystem
```
public S3FileSystem getFileSystem()
```
    Specified by:
    
    getFileSystem in interface Path
  - isAbsolute
```
public boolean isAbsolute()
```
    Specified by:
    
    isAbsolute in interface Path
  - getRoot
```
public Path getRoot()
```
    Specified by:
    
    getRoot in interface Path
  - getFileName
```
public Path getFileName()
```
    Specified by:
    
    getFileName in interface Path
  - getParent
```
public Path getParent()
```
    Specified by:
    
    getParent in interface Path
  - getNameCount
```
public int getNameCount()
```
    Specified by:
    
    getNameCount in interface Path
  - getName
```
public Path getName(int index)
```
    Specified by:
    
    getName in interface Path
  - subpath
```
public Path subpath(int beginIndex,
                    int endIndex)
```
    The bucket name not count
    
    Specified by:
    
    subpath in interface Path
  - startsWith
```
public boolean startsWith(Path other)
```
    Specified by:
    
    startsWith in interface Path
  - startsWith
```
public boolean startsWith(String path)
```
    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 Path normalize()
```
    Specified by:
    
    normalize in interface Path
  - resolve
```
public Path resolve(Path other)
```
    Specified by:
    
    resolve in interface Path
  - resolve
```
public Path resolve(String other)
```
    Specified by:
    
    resolve in interface Path
  - resolveSibling
```
public Path resolveSibling(Path other)
```
    Specified by:
    
    resolveSibling in interface Path
  - resolveSibling
```
public Path resolveSibling(String other)
```
    Specified by:
    
    resolveSibling in interface Path
  - relativize
```
public Path relativize(Path other)
```
    Specified by:
    
    relativize in interface Path
  - toUri
```
public URI toUri()
```
    Examples: Relative: -------- NO use fileSystem and not used fileStore. - path/file Absolute: -------- Use the fileSystem to get the host and the filestore to get the first path (in the future the filestore can be attached to the host) http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html - s3://AMAZONACCESSKEY@s3.amazonaws.com/bucket/path/file - s3://AMAZONACCESSKEY@bucket.s3.amazonaws.com/path/file - s3://s3-aws-region.amazonaws.com/bucket/path/file
    
    Specified by:
    
    toUri in interface Path
    
    Returns:
    
    URI never null
  - toURL
```
public URL toURL()
```
    Get the url for the s3Path. The url represents a Uniform Resource Locator, a pointer to a "resource" on the World Wide Web. All S3Path has a URL if is absolute
    
    Returns:
    
    URL or null if is not absoulte
    
    See Also:
    
    AmazonS3.getUrl(String, String), for unique resource identifier
  - toAbsolutePath
```
public Path toAbsolutePath()
```
    Specified by:
    
    toAbsolutePath in interface Path
  - toRealPath
```
public Path toRealPath(LinkOption... options)
                throws IOException
```
    Specified by:
    
    toRealPath in interface Path
    
    Throws:
    
    IOException
  - toFile
```
public File toFile()
```
    Specified by:
    
    toFile in interface Path
  - 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
  - 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
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Path
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    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
  - getFileAttributes
```
public S3BasicFileAttributes getFileAttributes()
```
  - setFileAttributes
```
public void setFileAttributes(S3BasicFileAttributes fileAttributes)
```

Class S3Path

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

PATH_SEPARATOR

Constructor Detail

S3Path

Method Detail

getFileStore

getKey

getFileSystem

isAbsolute

getRoot

getFileName

getParent

getNameCount

getName

subpath

startsWith

startsWith

endsWith

endsWith

normalize

resolve

resolve

resolveSibling

resolveSibling

relativize

toUri

toURL

toAbsolutePath

toRealPath

toFile

register

register

iterator

compareTo

toString

equals

hashCode

getFileAttributes

setFileAttributes