org.refcodes.component.Component
, org.refcodes.component.Destroyable
, FileSystem
public class InMemoryFileSystemImpl extends Object implements FileSystem
FileSystem
using an ConcurrentHashMap
for
implementation.PATH_DELIMITER
Constructor | Description |
---|---|
InMemoryFileSystemImpl() |
Constructs an in-memory
FileSystem . |
Modifier and Type | Method | Description |
---|---|---|
FileHandle |
createFile(String aKey) |
Creates a file (handle) with the given key.
|
FileHandle |
createFile(String aPath,
String aName) |
Creates a file (handle) with the given path and name.
|
void |
deleteFile(FileHandle aFileHandle) |
Deletes a file (handle) from the file system.
|
void |
destroy() |
|
InputStream |
fromFile(FileHandle aFromFileHandle) |
An input stream is being provided from which the data of the file
(handle) may be read.
|
void |
fromFile(FileHandle aFromFileHandle,
File aToFile) |
The data contained in the given file (handle) is written to the provided
file.
|
void |
fromFile(FileHandle aFromFileHandle,
OutputStream aOutputStream) |
The data contained in the given file (handle) is written to the provided
output stream.
|
FileHandle |
getFileHandle(String aKey) |
Gets a file (handle) with the given key from the file system.
|
FileHandle |
getFileHandle(String aPath,
String aName) |
Gets a file (handle) with the given path and name from the file system.
|
List<FileHandle> |
getFileHandles(String aPath,
boolean isRecursively) |
With the behavior of the
FileSystem.hasFiles(String, boolean) method, all
file (handle)s found for the path are returned. |
boolean |
hasFile(String aKey) |
Tests whether the file system knows a file (handle) with the given key.
|
boolean |
hasFile(String aPath,
String aName) |
Tests whether the file system knows a file (handle) with the given path
and name.
|
boolean |
hasFile(FileHandle aFileHandle) |
Returns true in case the given file (handle) exists.
|
boolean |
hasFiles(String aPath,
boolean isRecursively) |
Determines whether there is any file (handle)s found for the given path.
|
FileHandle |
moveFile(FileHandle aFileHandle,
String aNewKey) |
Renames the file (handle), it will be accessible via the provided key.
|
FileHandle |
renameFile(FileHandle aFileHandle,
String aNewName) |
Renames the file (handle), the name part of the key will be renamed to
the new name.
|
OutputStream |
toFile(FileHandle aToFileHandle) |
Returns an output stream which may be used to write (or append, in case
data did already exist for the file system) data to a file (handle).
|
void |
toFile(FileHandle aToFileHandle,
byte[] aBuffer) |
Data provided by the given buffer is written to the file (handle) (or
appended to the file (handle)'s data in case the file (handle) did
already contain data).
|
void |
toFile(FileHandle aToFileHandle,
File aFromFile) |
Data provided by the given input stream is written to the file (handle)
(or appended to the file (handle)'s data in case the file (handle) did
already contain data).
|
void |
toFile(FileHandle aToFileHandle,
InputStream aInputStream) |
Data provided by the given input stream is written to the file (handle)
(or appended to the file (handle)'s data in case the file (handle) did
already contain data).
|
public InMemoryFileSystemImpl()
FileSystem
.public boolean hasFile(String aKey) throws IllegalKeyException, NoListAccessException, UnknownFileSystemException, IOException
hasFile
in interface FileSystem
aKey
- The key which to test if there is a file (handle).IllegalKeyException
- in case the path was not a valid path.NoListAccessException
- in case listing the content in the file
system was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle).public boolean hasFile(String aPath, String aName) throws IllegalPathException, IllegalNameException, NoListAccessException, UnknownFileSystemException, IOException
hasFile
in interface FileSystem
aPath
- The path part of the key for which to test if there is a
file (handle).aName
- The name part of the key for which to test if there is a
file (handle).IllegalPathException
- in case the path was not a valid path.IllegalNameException
- in case the name was not a valid path.NoListAccessException
- in case listing the content in the file
syste was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)public boolean hasFile(FileHandle aFileHandle) throws NoListAccessException, UnknownFileSystemException, IOException, IllegalFileHandleException
hasFile
in interface FileSystem
aFileHandle
- The file (handle) which's existence is to be tested.NoListAccessException
- in case listing the content in the file
system was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public FileHandle createFile(String aKey) throws FileAlreadyExistsException, NoCreateAccessException, IllegalKeyException, UnknownFileSystemException, IOException, NoListAccessException
createFile
in interface FileSystem
aKey
- The key for which to create the file (handle).FileAlreadyExistsException
- in case a file (handle) with the given
key (path and name) already exists.NoCreateAccessException
- in case create access to the file system
was denied.IllegalKeyException
- in case the key with name and path is not
valid, i.e. the name contains a path separator.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.public FileHandle createFile(String aPath, String aName) throws FileAlreadyExistsException, NoCreateAccessException, IllegalNameException, IllegalPathException, UnknownFileSystemException, IOException, NoListAccessException
createFile
in interface FileSystem
aPath
- The path part of the key for which to create the file
(handle).aName
- The name part of the key for which to create the file
(handle).FileAlreadyExistsException
- in case a file (handle) with the given
key (path and name) already exists.NoCreateAccessException
- in case create access to the file system
was denied.IllegalNameException
- in case the name was not a valid path.IllegalPathException
- in case the path was not a valid path.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.public FileHandle getFileHandle(String aKey) throws NoListAccessException, IllegalKeyException, UnknownFileSystemException, IOException, UnknownKeyException
getFileHandle
in interface FileSystem
aKey
- The key for which to retrieve the file (handle).NoListAccessException
- in case listing the content in the file
system was denied.IllegalKeyException
- in case the key with name and path is not
valid, i.e. the name contains a path separator.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)UnknownKeyException
- in case the given key (path and name) does
not exist in the file system.public FileHandle getFileHandle(String aPath, String aName) throws NoListAccessException, IllegalNameException, IllegalPathException, UnknownFileSystemException, IOException, UnknownKeyException
getFileHandle
in interface FileSystem
aPath
- The path part of the key for which to retrieve the file
(handle).aName
- The name part of the key for which to retrieve the file
(handle).NoListAccessException
- in case listing the content in the file
system was denied.IllegalNameException
- in case the name was not a valid path.IllegalPathException
- in case the path was not a valid path.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)UnknownKeyException
- in case the given key (path and name) does
not exist in the file system.public void fromFile(FileHandle aFromFileHandle, OutputStream aOutputStream) throws ConcurrentAccessException, UnknownFileException, NoReadAccessException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
fromFile
in interface FileSystem
aFromFileHandle
- The file (handle) which is to be written to the
output stream.aOutputStream
- The stream to which to write.ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoReadAccessException
- in case read access to the file system was
denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public void toFile(FileHandle aToFileHandle, InputStream aInputStream) throws ConcurrentAccessException, UnknownFileException, NoWriteAccessException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
toFile
in interface FileSystem
aToFileHandle
- The file (handle) to which data is to be written.aInputStream
- The input stream from which to read the data which is
to be written to the file (handle).ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoWriteAccessException
- in case write access to the file system
was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public InputStream fromFile(FileHandle aFromFileHandle) throws ConcurrentAccessException, UnknownFileException, UnknownFileException, NoReadAccessException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
fromFile
in interface FileSystem
aFromFileHandle
- The file (handle) for which to get the input
stream.ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoReadAccessException
- in case read access to the file system was
denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public OutputStream toFile(FileHandle aToFileHandle) throws ConcurrentAccessException, UnknownFileException, NoWriteAccessException, UnknownFileSystemException, IOException, IllegalFileHandleException
toFile
in interface FileSystem
aToFileHandle
- The file (handle) to which to write data.ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoWriteAccessException
- in case write access to the file system
was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public void fromFile(FileHandle aFromFileHandle, File aToFile) throws ConcurrentAccessException, UnknownFileException, NoReadAccessException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
fromFile
in interface FileSystem
aFromFileHandle
- The file (handle) which is to be written to the
output stream.aToFile
- The file to which the data is to be written.ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoReadAccessException
- in case read access to the file system was
denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public void toFile(FileHandle aToFileHandle, File aFromFile) throws ConcurrentAccessException, UnknownFileException, NoWriteAccessException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
toFile
in interface FileSystem
aToFileHandle
- The file (handle) to which data is to be written.aFromFile
- The file from which to read the data which is to be
written to the file (handle).ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoWriteAccessException
- in case write access to the file system
was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public void toFile(FileHandle aToFileHandle, byte[] aBuffer) throws ConcurrentAccessException, UnknownFileException, NoWriteAccessException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
toFile
in interface FileSystem
aToFileHandle
- The file (handle) to which data is to be written.aBuffer
- The buffer from which to read the data which is to be
written to the file (handle).ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoWriteAccessException
- in case write access to the file system
was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public FileHandle renameFile(FileHandle aFileHandle, String aNewName) throws UnknownFileException, ConcurrentAccessException, FileAlreadyExistsException, NoCreateAccessException, NoDeleteAccessException, IllegalNameException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
renameFile
in interface FileSystem
aFileHandle
- The file (handle) to be renamed.aNewName
- The new name of the file (handle).UnknownFileException
- in case none such file (handle) was found in
the file system.ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.FileAlreadyExistsException
- in case a file (handle) with the given
key (path and name) already exists.NoCreateAccessException
- in case create access to the file system
was denied.NoDeleteAccessException
- in case create access to the file system
was denied.IllegalNameException
- in case the name was not a valid path.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public FileHandle moveFile(FileHandle aFileHandle, String aNewKey) throws UnknownFileException, ConcurrentAccessException, FileAlreadyExistsException, NoCreateAccessException, NoDeleteAccessException, IllegalKeyException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
moveFile
in interface FileSystem
aFileHandle
- The file (handle) to be renamed.aNewKey
- The new key (path and name) of the file (handle).UnknownFileException
- in case none such file (handle) was found in
the file system.ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.FileAlreadyExistsException
- in case a file (handle) with the given
key (path and name) already exists.NoCreateAccessException
- in case create access to the file system
was denied.NoDeleteAccessException
- in case create access to the file system
was denied.IllegalKeyException
- in case the key with name and path is not
valid, i.e. the name contains a path separator.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public void deleteFile(FileHandle aFileHandle) throws ConcurrentAccessException, UnknownFileException, NoDeleteAccessException, UnknownFileSystemException, IOException, NoListAccessException, IllegalFileHandleException
deleteFile
in interface FileSystem
aFileHandle
- The file (handle) to be deleted.ConcurrentAccessException
- in case the file (handle) is
concurrently read, modified or deleted.UnknownFileException
- in case none such file (handle) was found in
the file system.NoDeleteAccessException
- in case create access to the file system
was denied.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)NoListAccessException
- in case listing the content in the file
system was denied.IllegalFileHandleException
- in case the file handle with name and
path is not valid, i.e. the name contains a path separator.public boolean hasFiles(String aPath, boolean isRecursively) throws NoListAccessException, IllegalPathException, UnknownFileSystemException, IOException
hasFiles
in interface FileSystem
aPath
- The path where to look whether there are file (handle)s or
not.isRecursively
- When true all children of that path are examined as
well.NoListAccessException
- in case listing the content in the file
system was denied.IllegalPathException
- in case the path was not a valid path.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)public List<FileHandle> getFileHandles(String aPath, boolean isRecursively) throws NoListAccessException, UnknownPathException, IllegalPathException, UnknownFileSystemException, IOException
FileSystem.hasFiles(String, boolean)
method, all
file (handle)s found for the path are returned. Especially the recursive
flag is described in the method FileSystem.hasFiles(String, boolean)
.getFileHandles
in interface FileSystem
aPath
- The path where to search for the file (handle)s.isRecursively
- the is recursivelyNoListAccessException
- in case listing the content in the file
system was denied.UnknownPathException
- in case the given path did not exist in the
file system.IllegalPathException
- in case the path was not a valid path.UnknownFileSystemException
- in case the "underlying" (physical)
file system is not known (may not exist any more), i.e. it may
have been removed after the file system instance has been
created.IOException
- in case an I/O related problem occurred while
accessing the file (handle)public void destroy()
destroy
in interface org.refcodes.component.Destroyable
Copyright © 2018. All rights reserved.