com.github.fge.fs.dropbox.driver

Class DropBoxFileSystemDriver

java.lang.Object

com.github.fge.filesystem.driver.FileSystemDriverBase

com.github.fge.filesystem.driver.UnixLikeFileSystemDriverBase

com.github.fge.fs.dropbox.driver.DropBoxFileSystemDriver

All Implemented Interfaces:

com.github.fge.filesystem.driver.FileSystemDriver, Closeable, AutoCloseable

@ParametersAreNonnullByDefault
public final class DropBoxFileSystemDriver
extends com.github.fge.filesystem.driver.UnixLikeFileSystemDriverBase

Field Summary

Fields inherited from class com.github.fge.filesystem.driver.FileSystemDriverBase

pathElementsFactory

Constructor Summary

Constructors

Constructor and Description
DropBoxFileSystemDriver(URI uri, DbxClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkAccess(Path path, AccessMode... modes) Check access modes for a path on this filesystem
void	close() Closes this stream and releases any system resources associated with it.
void	copy(Path source, Path target, CopyOption... options) Copy a file, or empty directory, from one path to another on this filesystem
void	createDirectory(Path dir, FileAttribute<?>... attrs) Create a new directory from a path on this filesystem
void	delete(Path path) Delete a file, or empty directory, matching a path on this filesystem
<V extends FileAttributeView> V	getFileAttributeView(Path path, Class<V> type, LinkOption... options) Read an attribute view for a given path on this filesystem
void	move(Path source, Path target, CopyOption... options) Move a file, or empty directory, from one path to another on this filesystem
DirectoryStream<Path>	newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) Create a new directory stream from a path for this filesystem
InputStream	newInputStream(Path path, OpenOption... options) Obtain a new InputStream from a path for this filesystem
OutputStream	newOutputStream(Path path, OpenOption... options) Obtain a new OutputStream from a path for this filesystem
<A extends BasicFileAttributes> A	readAttributes(Path path, Class<A> type, LinkOption... options) Read attributes from a path on this filesystem
Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options) Read a list of attributes from a path on this filesystem
void	setAttribute(Path path, String attribute, Object value, LinkOption... options) Set an attribute for a path on this filesystem

Methods inherited from class com.github.fge.filesystem.driver.UnixLikeFileSystemDriverBase

isHidden

Methods inherited from class com.github.fge.filesystem.driver.FileSystemDriverBase

getFileStore, getPathElementsFactory, getPathMatcherProvider, getRoot, getSupportedFileAttributeViews, getUri, getUserPrincipalLookupService, isSameFile, newByteChannel, newWatchService

Methods inherited from class java.lang.Object

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

Constructor Detail

DropBoxFileSystemDriver

public DropBoxFileSystemDriver(URI uri,
                       DbxClient client)

Method Detail

newInputStream

@Nonnull
public InputStream newInputStream(Path path,
                                 OpenOption... options)
                           throws IOException

Obtain a new InputStream from a path for this filesystem

Parameters:

path - the path

options - the set of open options

Returns:

a new input stream

Throws:

IOException - filesystem level error, or plain I/O error

See Also:

FileSystemProvider.newInputStream(Path, OpenOption...)

newOutputStream

@Nonnull
public OutputStream newOutputStream(Path path,
                                   OpenOption... options)
                             throws IOException

Obtain a new OutputStream from a path for this filesystem

Parameters:

path - the path

options - the set of open options

Returns:

a new output stream

Throws:

IOException - filesystem level error, or plain I/O error

See Also:

FileSystemProvider.newOutputStream(Path, OpenOption...)

newDirectoryStream

@Nonnull
public DirectoryStream<Path> newDirectoryStream(Path dir,
                                               DirectoryStream.Filter<? super Path> filter)
                                         throws IOException

Create a new directory stream from a path for this filesystem

Parameters:

dir - the directory

filter - a directory entry filter

Returns:

a directory stream

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.newDirectoryStream(Path, DirectoryStream.Filter)

createDirectory

public void createDirectory(Path dir,
                   FileAttribute<?>... attrs)
                     throws IOException

Create a new directory from a path on this filesystem

Parameters:

dir - the directory to create

attrs - the attributes with which the directory should be created

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.createDirectory(Path, FileAttribute[])

delete

public void delete(Path path)
            throws IOException

Delete a file, or empty directory, matching a path on this filesystem

Parameters:

path - the victim

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.delete(Path)

copy

public void copy(Path source,
        Path target,
        CopyOption... options)
          throws IOException

Copy a file, or empty directory, from one path to another on this filesystem

Parameters:

source - the source path

target - the target path

options - the copy options

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.copy(Path, Path, CopyOption...)

move

public void move(Path source,
        Path target,
        CopyOption... options)
          throws IOException

Move a file, or empty directory, from one path to another on this filesystem

Parameters:

source - the source path

target - the target path

options - the copy options

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.move(Path, Path, CopyOption...)

checkAccess

public void checkAccess(Path path,
               AccessMode... modes)
                 throws IOException

Check access modes for a path on this filesystem

If no modes are provided to check for, this simply checks for the existence of the path.

Parameters:

path - the path to check

modes - the modes to check for, if any

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.checkAccess(Path, AccessMode...)

getFileAttributeView

@Nullable
public <V extends FileAttributeView> V getFileAttributeView(Path path,
                                                            Class<V> type,
                                                            LinkOption... options)

Read an attribute view for a given path on this filesystem

Parameters:

path - the path to read attributes from

type - the class of attribute view to return

options - the link options

Returns:

the attributes view; null if this view is not supported

See Also:

FileSystemProvider.getFileAttributeView(Path, Class, LinkOption...)

readAttributes

public <A extends BasicFileAttributes> A readAttributes(Path path,
                                               Class<A> type,
                                               LinkOption... options)
                                             throws IOException

Read attributes from a path on this filesystem

Parameters:

path - the path to read attributes from

type - the class of attributes to read

options - the link options

Returns:

the attributes

Throws:

IOException - filesystem level error, or a plain I/O error

UnsupportedOperationException - attribute type not supported

See Also:

FileSystemProvider.readAttributes(Path, Class, LinkOption...)

readAttributes

public Map<String,Object> readAttributes(Path path,
                                String attributes,
                                LinkOption... options)
                                  throws IOException

Read a list of attributes from a path on this filesystem

Parameters:

path - the path to read attributes from

attributes - the list of attributes to read

options - the link options

Returns:

the relevant attributes as a map

Throws:

IOException - filesystem level error, or a plain I/O error

IllegalArgumentException - malformed attributes string; or a specified attribute does not exist

UnsupportedOperationException - one or more attribute(s) is/are not supported

See Also:

Files.readAttributes(Path, String, LinkOption...), FileSystemProvider.readAttributes(Path, String, LinkOption...)

setAttribute

public void setAttribute(Path path,
                String attribute,
                Object value,
                LinkOption... options)
                  throws IOException

Set an attribute for a path on this filesystem

Parameters:

path - the victim

attribute - the name of the attribute to set

value - the value to set

options - the link options

Throws:

IOException - filesystem level error, or a plain I/O error

IllegalArgumentException - malformed attribute, or the specified attribute does not exist

UnsupportedOperationException - the attribute to set is not supported by this filesystem

ClassCastException - attribute value is of the wrong class for the specified attribute

See Also:

Files.setAttribute(Path, String, Object, LinkOption...), FileSystemProvider.setAttribute(Path, String, Object, LinkOption...)

close

public void close()
           throws IOException

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Throws:

IOException - if an I/O error occurs