com.palantir.giraffe.file.base

Class CachingBaseFileSystemProvider<P extends BasePath<P>>

java.lang.Object

java.nio.file.spi.FileSystemProvider

com.palantir.giraffe.file.base.BaseFileSystemProvider<P>

com.palantir.giraffe.file.base.CachingBaseFileSystemProvider<P>

Type Parameters:

P - the type of path used by the provider's file systems

public abstract class CachingBaseFileSystemProvider<P extends BasePath<P>>
extends BaseFileSystemProvider<P>

A BaseFileSystemProvider that caches created file systems, allowing at most one open file system for a given URI at a time. A new file system can be created for a given URI after the previous one is closed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CachingBaseFileSystemProvider(Class<P> pathClass)

Method Summary

Modifier and Type	Method and Description
protected abstract URI	checkUri(URI uri) Checks that uri is a valid URI for a file system from this provider.
FileSystem	getFileSystem(URI uri)
FileSystem	newFileSystem(URI uri, Map<String,?> env)
protected abstract BaseFileSystem<P>	openFileSystem(URI uri, Map<String,?> env) Creates a new, open file system.
protected Object	uriToCacheKey(URI uri) Converts uri into a cache key.

Methods inherited from class com.palantir.giraffe.file.base.BaseFileSystemProvider

checkAccess, checkPath, createDirectory, delete, getFileAttributeView, isCompatible, isHidden, isSameFile, newByteChannel, newDirectoryStream, readAttributes, readAttributes, setAttribute

Methods inherited from class java.nio.file.spi.FileSystemProvider

copy, createLink, createSymbolicLink, deleteIfExists, getFileStore, getPath, getScheme, installedProviders, move, newAsynchronousFileChannel, newFileChannel, newFileSystem, newInputStream, newOutputStream, readSymbolicLink

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingBaseFileSystemProvider

protected CachingBaseFileSystemProvider(Class<P> pathClass)

Method Detail

newFileSystem

public final FileSystem newFileSystem(URI uri,
                                      Map<String,?> env)
                               throws IOException

Specified by:

newFileSystem in class FileSystemProvider

Throws:

IOException

openFileSystem

protected abstract BaseFileSystem<P> openFileSystem(URI uri,
                                                    Map<String,?> env)
                                             throws IOException

Creates a new, open file system. The file system returned by this method is cached until it is closed.

Parameters:

uri - a valid file system URI

env - a possible empty map of provider specific properties

Returns:

a new file system

Throws:

IllegalArgumentException - if env does the contain require properties or if a property value is invalid

IOException - if an I/O error occurs creating the file system

getFileSystem

public final FileSystem getFileSystem(URI uri)

Specified by:

getFileSystem in class FileSystemProvider

checkUri

protected abstract URI checkUri(URI uri)

Checks that uri is a valid URI for a file system from this provider.

Parameters:

uri - the URI to check

Returns:

the given URI

Throws:

IllegalArgumentException - if the URI is invalid

uriToCacheKey

protected Object uriToCacheKey(URI uri)

Converts uri into a cache key. By default, this method returns the given URI.