public class FileSystemImpl extends Object implements FileSystem
Modifier and Type | Class and Description |
---|---|
protected class |
FileSystemImpl.BlockingAction<T> |
Modifier and Type | Field and Description |
---|---|
protected VertxInternal |
vertx |
Constructor and Description |
---|
FileSystemImpl(VertxInternal vertx) |
Modifier and Type | Method and Description |
---|---|
FileSystem |
chmod(String path,
String perms,
Handler<AsyncResult<Void>> handler)
Change the permissions on the file represented by
path to perms , asynchronously. |
FileSystem |
chmodBlocking(String path,
String perms)
Blocking version of
FileSystem.chmod(String, String, Handler) |
protected FileSystemImpl.BlockingAction<Void> |
chmodInternal(String path,
String perms,
String dirPerms,
Handler<AsyncResult<Void>> handler) |
FileSystem |
chmodRecursive(String path,
String perms,
String dirPerms,
Handler<AsyncResult<Void>> handler)
Change the permissions on the file represented by
path to perms , asynchronously. |
FileSystem |
chmodRecursiveBlocking(String path,
String perms,
String dirPerms)
Blocking version of
FileSystem.chmodRecursive(String, String, String, Handler) |
FileSystem |
chown(String path,
String user,
String group,
Handler<AsyncResult<Void>> handler)
Change the ownership on the file represented by
path to user and {code group}, asynchronously. |
FileSystem |
chownBlocking(String path,
String user,
String group)
Blocking version of
FileSystem.chown(String, String, String, Handler) |
protected FileSystemImpl.BlockingAction<Void> |
chownInternal(String path,
String user,
String group,
Handler<AsyncResult<Void>> handler) |
FileSystem |
copy(String from,
String to,
Handler<AsyncResult<Void>> handler)
Copy a file from the path
from to path to , asynchronously. |
FileSystem |
copyBlocking(String from,
String to)
Blocking version of
FileSystem.copy(String, String, Handler) |
FileSystem |
copyRecursive(String from,
String to,
boolean recursive,
Handler<AsyncResult<Void>> handler)
Copy a file from the path
from to path to , asynchronously. |
FileSystem |
copyRecursiveBlocking(String from,
String to,
boolean recursive)
Blocking version of
FileSystem.copyRecursive(String, String, boolean, Handler) |
FileSystem |
createFile(String path,
Handler<AsyncResult<Void>> handler)
Creates an empty file with the specified
path , asynchronously. |
FileSystem |
createFile(String path,
String perms,
Handler<AsyncResult<Void>> handler)
Creates an empty file with the specified
path and permissions perms , asynchronously. |
FileSystem |
createFileBlocking(String path)
Blocking version of
FileSystem.createFile(String, Handler) |
FileSystem |
createFileBlocking(String path,
String perms)
Blocking version of
FileSystem.createFile(String, String, Handler) |
protected FileSystemImpl.BlockingAction<Void> |
createFileInternal(String p,
String perms,
Handler<AsyncResult<Void>> handler) |
FileSystem |
delete(String path,
Handler<AsyncResult<Void>> handler)
Deletes the file represented by the specified
path , asynchronously. |
FileSystem |
deleteBlocking(String path)
Blocking version of
FileSystem.delete(String, Handler) |
FileSystem |
deleteRecursive(String path,
boolean recursive,
Handler<AsyncResult<Void>> handler)
Deletes the file represented by the specified
path , asynchronously. |
FileSystem |
deleteRecursiveBlocking(String path,
boolean recursive)
Blocking version of
FileSystem.deleteRecursive(String, boolean, Handler) |
protected AsyncFile |
doOpen(String path,
OpenOptions options,
ContextImpl context) |
FileSystem |
exists(String path,
Handler<AsyncResult<Boolean>> handler)
Determines whether the file as specified by the path
path exists, asynchronously. |
boolean |
existsBlocking(String path)
Blocking version of
FileSystem.exists(String, Handler) |
FileSystem |
fsProps(String path,
Handler<AsyncResult<FileSystemProps>> handler)
Returns properties of the file-system being used by the specified
path , asynchronously. |
FileSystemProps |
fsPropsBlocking(String path)
Blocking version of
FileSystem.fsProps(String, Handler) |
FileSystem |
link(String link,
String existing,
Handler<AsyncResult<Void>> handler)
Create a hard link on the file system from
link to existing , asynchronously. |
FileSystem |
linkBlocking(String link,
String existing)
Blocking version of
FileSystem.link(String, String, Handler) |
FileSystem |
lprops(String path,
Handler<AsyncResult<FileProps>> handler)
Obtain properties for the link represented by
path , asynchronously. |
FileProps |
lpropsBlocking(String path)
Blocking version of
FileSystem.lprops(String, Handler) |
FileSystem |
mkdir(String path,
Handler<AsyncResult<Void>> handler)
Create the directory represented by
path , asynchronously. |
FileSystem |
mkdir(String path,
String perms,
Handler<AsyncResult<Void>> handler)
Create the directory represented by
path , asynchronously. |
FileSystem |
mkdirBlocking(String path)
Blocking version of
FileSystem.mkdir(String, Handler) |
FileSystem |
mkdirBlocking(String path,
String perms)
Blocking version of
FileSystem.mkdir(String, String, Handler) |
protected FileSystemImpl.BlockingAction<Void> |
mkdirInternal(String path,
String perms,
boolean createParents,
Handler<AsyncResult<Void>> handler) |
FileSystem |
mkdirs(String path,
Handler<AsyncResult<Void>> handler)
Create the directory represented by
path and any non existent parents, asynchronously. |
FileSystem |
mkdirs(String path,
String perms,
Handler<AsyncResult<Void>> handler)
Create the directory represented by
path and any non existent parents, asynchronously. |
FileSystem |
mkdirsBlocking(String path)
Blocking version of
FileSystem.mkdirs(String, Handler) |
FileSystem |
mkdirsBlocking(String path,
String perms)
Blocking version of
FileSystem.mkdirs(String, String, Handler) |
FileSystem |
move(String from,
String to,
Handler<AsyncResult<Void>> handler)
Move a file from the path
from to path to , asynchronously. |
FileSystem |
moveBlocking(String from,
String to)
Blocking version of
FileSystem.move(String, String, Handler) |
FileSystem |
open(String path,
OpenOptions options,
Handler<AsyncResult<AsyncFile>> handler)
Open the file represented by
path , asynchronously. |
AsyncFile |
openBlocking(String path,
OpenOptions options)
Blocking version of
FileSystem.open(String, io.vertx.core.file.OpenOptions, Handler) |
FileSystem |
props(String path,
Handler<AsyncResult<FileProps>> handler)
Obtain properties for the file represented by
path , asynchronously. |
FileProps |
propsBlocking(String path)
Blocking version of
FileSystem.props(String, Handler) |
FileSystem |
readDir(String path,
Handler<AsyncResult<List<String>>> handler)
Read the contents of the directory specified by
path , asynchronously. |
FileSystem |
readDir(String path,
String filter,
Handler<AsyncResult<List<String>>> handler)
Read the contents of the directory specified by
path , asynchronously. |
List<String> |
readDirBlocking(String path)
Blocking version of
FileSystem.readDir(String, Handler) |
List<String> |
readDirBlocking(String path,
String filter)
Blocking version of
FileSystem.readDir(String, String, Handler) |
FileSystem |
readFile(String path,
Handler<AsyncResult<Buffer>> handler)
Reads the entire file as represented by the path
path as a Buffer , asynchronously. |
Buffer |
readFileBlocking(String path)
Blocking version of
FileSystem.readFile(String, Handler) |
FileSystem |
readSymlink(String link,
Handler<AsyncResult<String>> handler)
Returns the path representing the file that the symbolic link specified by
link points to, asynchronously. |
String |
readSymlinkBlocking(String link)
Blocking version of
FileSystem.readSymlink(String, Handler) |
FileSystem |
symlink(String link,
String existing,
Handler<AsyncResult<Void>> handler)
Create a symbolic link on the file system from
link to existing , asynchronously. |
FileSystem |
symlinkBlocking(String link,
String existing)
Blocking version of
FileSystem.link(String, String, Handler) |
FileSystem |
truncate(String path,
long len,
Handler<AsyncResult<Void>> handler)
Truncate the file represented by
path to length len in bytes, asynchronously. |
FileSystem |
truncateBlocking(String path,
long len)
Blocking version of
FileSystem.truncate(String, long, Handler) |
FileSystem |
unlink(String link,
Handler<AsyncResult<Void>> handler)
Unlinks the link on the file system represented by the path
link , asynchronously. |
FileSystem |
unlinkBlocking(String link)
Blocking version of
FileSystem.unlink(String, Handler) |
FileSystem |
writeFile(String path,
Buffer data,
Handler<AsyncResult<Void>> handler)
Creates the file, and writes the specified
Buffer data to the file represented by the path path ,
asynchronously. |
FileSystem |
writeFileBlocking(String path,
Buffer data)
Blocking version of
FileSystem.writeFile(String, Buffer, Handler) |
protected final VertxInternal vertx
public FileSystemImpl(VertxInternal vertx)
public FileSystem copy(String from, String to, Handler<AsyncResult<Void>> handler)
FileSystem
from
to path to
, asynchronously.
The copy will fail if the destination already exists.
copy
in interface FileSystem
from
- the path to copy fromto
- the path to copy tohandler
- the handler that will be called on completionpublic FileSystem copyBlocking(String from, String to)
FileSystem
FileSystem.copy(String, String, Handler)
copyBlocking
in interface FileSystem
public FileSystem copyRecursive(String from, String to, boolean recursive, Handler<AsyncResult<Void>> handler)
FileSystem
from
to path to
, asynchronously.
If recursive
is true
and from
represents a directory, then the directory and its contents
will be copied recursively to the destination to
.
The copy will fail if the destination if the destination already exists.
copyRecursive
in interface FileSystem
from
- the path to copy fromto
- the path to copy tohandler
- the handler that will be called on completionpublic FileSystem copyRecursiveBlocking(String from, String to, boolean recursive)
FileSystem
FileSystem.copyRecursive(String, String, boolean, Handler)
copyRecursiveBlocking
in interface FileSystem
public FileSystem move(String from, String to, Handler<AsyncResult<Void>> handler)
FileSystem
from
to path to
, asynchronously.
The move will fail if the destination already exists.
move
in interface FileSystem
from
- the path to copy fromto
- the path to copy tohandler
- the handler that will be called on completionpublic FileSystem moveBlocking(String from, String to)
FileSystem
FileSystem.move(String, String, Handler)
moveBlocking
in interface FileSystem
public FileSystem truncate(String path, long len, Handler<AsyncResult<Void>> handler)
FileSystem
path
to length len
in bytes, asynchronously.
The operation will fail if the file does not exist or len
is less than zero
.
truncate
in interface FileSystem
path
- the path to the filelen
- the length to truncate it tohandler
- the handler that will be called on completionpublic FileSystem truncateBlocking(String path, long len)
FileSystem
FileSystem.truncate(String, long, Handler)
truncateBlocking
in interface FileSystem
public FileSystem chmod(String path, String perms, Handler<AsyncResult<Void>> handler)
FileSystem
path
to perms
, asynchronously.
The permission String takes the form rwxr-x--- as specified here.
chmod
in interface FileSystem
path
- the path to the fileperms
- the permissions stringhandler
- the handler that will be called on completionpublic FileSystem chmodBlocking(String path, String perms)
FileSystem
FileSystem.chmod(String, String, Handler)
chmodBlocking
in interface FileSystem
public FileSystem chmodRecursive(String path, String perms, String dirPerms, Handler<AsyncResult<Void>> handler)
FileSystem
path
to perms
, asynchronously.The permission String takes the form rwxr-x--- as specified in {here}.
If the file is directory then all contents will also have their permissions changed recursively. Any directory permissions will
be set to dirPerms
, whilst any normal file permissions will be set to perms
.
chmodRecursive
in interface FileSystem
path
- the path to the fileperms
- the permissions stringdirPerms
- the directory permissionshandler
- the handler that will be called on completionpublic FileSystem chmodRecursiveBlocking(String path, String perms, String dirPerms)
FileSystem
FileSystem.chmodRecursive(String, String, String, Handler)
chmodRecursiveBlocking
in interface FileSystem
public FileSystem chown(String path, String user, String group, Handler<AsyncResult<Void>> handler)
FileSystem
path
to user
and {code group}, asynchronously.chown
in interface FileSystem
path
- the path to the fileuser
- the user namegroup
- the user grouphandler
- the handler that will be called on completionpublic FileSystem chownBlocking(String path, String user, String group)
FileSystem
FileSystem.chown(String, String, String, Handler)
chownBlocking
in interface FileSystem
public FileSystem props(String path, Handler<AsyncResult<FileProps>> handler)
FileSystem
path
, asynchronously.
If the file is a link, the link will be followed.
props
in interface FileSystem
path
- the path to the filehandler
- the handler that will be called on completionpublic FileProps propsBlocking(String path)
FileSystem
FileSystem.props(String, Handler)
propsBlocking
in interface FileSystem
public FileSystem lprops(String path, Handler<AsyncResult<FileProps>> handler)
FileSystem
path
, asynchronously.
The link will not be followed.
lprops
in interface FileSystem
path
- the path to the filehandler
- the handler that will be called on completionpublic FileProps lpropsBlocking(String path)
FileSystem
FileSystem.lprops(String, Handler)
lpropsBlocking
in interface FileSystem
public FileSystem link(String link, String existing, Handler<AsyncResult<Void>> handler)
FileSystem
link
to existing
, asynchronously.link
in interface FileSystem
link
- the linkexisting
- the link destinationhandler
- the handler that will be called on completionpublic FileSystem linkBlocking(String link, String existing)
FileSystem
FileSystem.link(String, String, Handler)
linkBlocking
in interface FileSystem
public FileSystem symlink(String link, String existing, Handler<AsyncResult<Void>> handler)
FileSystem
link
to existing
, asynchronously.symlink
in interface FileSystem
link
- the linkexisting
- the link destinationhandler
- the handler that will be called on completionpublic FileSystem symlinkBlocking(String link, String existing)
FileSystem
FileSystem.link(String, String, Handler)
symlinkBlocking
in interface FileSystem
public FileSystem unlink(String link, Handler<AsyncResult<Void>> handler)
FileSystem
link
, asynchronously.unlink
in interface FileSystem
link
- the linkhandler
- the handler that will be called on completionpublic FileSystem unlinkBlocking(String link)
FileSystem
FileSystem.unlink(String, Handler)
unlinkBlocking
in interface FileSystem
public FileSystem readSymlink(String link, Handler<AsyncResult<String>> handler)
FileSystem
link
points to, asynchronously.readSymlink
in interface FileSystem
link
- the linkhandler
- the handler that will be called on completionpublic String readSymlinkBlocking(String link)
FileSystem
FileSystem.readSymlink(String, Handler)
readSymlinkBlocking
in interface FileSystem
public FileSystem delete(String path, Handler<AsyncResult<Void>> handler)
FileSystem
path
, asynchronously.delete
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic FileSystem deleteBlocking(String path)
FileSystem
FileSystem.delete(String, Handler)
deleteBlocking
in interface FileSystem
public FileSystem deleteRecursive(String path, boolean recursive, Handler<AsyncResult<Void>> handler)
FileSystem
path
, asynchronously.
If the path represents a directory and recursive = true
then the directory and its contents will be
deleted recursively.
deleteRecursive
in interface FileSystem
path
- path to the filerecursive
- delete recursively?handler
- the handler that will be called on completionpublic FileSystem deleteRecursiveBlocking(String path, boolean recursive)
FileSystem
FileSystem.deleteRecursive(String, boolean, Handler)
deleteRecursiveBlocking
in interface FileSystem
public FileSystem mkdir(String path, Handler<AsyncResult<Void>> handler)
FileSystem
path
, asynchronously.
The operation will fail if the directory already exists.
mkdir
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic FileSystem mkdirBlocking(String path)
FileSystem
FileSystem.mkdir(String, Handler)
mkdirBlocking
in interface FileSystem
public FileSystem mkdirs(String path, Handler<AsyncResult<Void>> handler)
FileSystem
path
and any non existent parents, asynchronously.
The operation will fail if the directory already exists.
mkdirs
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic FileSystem mkdirsBlocking(String path)
FileSystem
FileSystem.mkdirs(String, Handler)
mkdirsBlocking
in interface FileSystem
public FileSystem mkdir(String path, String perms, Handler<AsyncResult<Void>> handler)
FileSystem
path
, asynchronously.
The new directory will be created with permissions as specified by perms
.
The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the directory already exists.
mkdir
in interface FileSystem
path
- path to the fileperms
- the permissions stringhandler
- the handler that will be called on completionpublic FileSystem mkdirBlocking(String path, String perms)
FileSystem
FileSystem.mkdir(String, String, Handler)
mkdirBlocking
in interface FileSystem
public FileSystem mkdirs(String path, String perms, Handler<AsyncResult<Void>> handler)
FileSystem
path
and any non existent parents, asynchronously.
The new directory will be created with permissions as specified by perms
.
The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the directory already exists.
mkdirs
in interface FileSystem
path
- path to the fileperms
- the permissions stringhandler
- the handler that will be called on completionpublic FileSystem mkdirsBlocking(String path, String perms)
FileSystem
FileSystem.mkdirs(String, String, Handler)
mkdirsBlocking
in interface FileSystem
public FileSystem readDir(String path, Handler<AsyncResult<List<String>>> handler)
FileSystem
path
, asynchronously.
The result is an array of String representing the paths of the files inside the directory.
readDir
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic List<String> readDirBlocking(String path)
FileSystem
FileSystem.readDir(String, Handler)
readDirBlocking
in interface FileSystem
public FileSystem readDir(String path, String filter, Handler<AsyncResult<List<String>>> handler)
FileSystem
path
, asynchronously.
The parameter filter
is a regular expression. If filter
is specified then only the paths that
match @{filter}will be returned.
The result is an array of String representing the paths of the files inside the directory.
readDir
in interface FileSystem
path
- path to the directoryfilter
- the filter expressionhandler
- the handler that will be called on completionpublic List<String> readDirBlocking(String path, String filter)
FileSystem
FileSystem.readDir(String, String, Handler)
readDirBlocking
in interface FileSystem
public FileSystem readFile(String path, Handler<AsyncResult<Buffer>> handler)
FileSystem
path
as a Buffer
, asynchronously.
Do not user this method to read very large files or you risk running out of available RAM.
readFile
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic Buffer readFileBlocking(String path)
FileSystem
FileSystem.readFile(String, Handler)
readFileBlocking
in interface FileSystem
public FileSystem writeFile(String path, Buffer data, Handler<AsyncResult<Void>> handler)
FileSystem
Buffer data
to the file represented by the path path
,
asynchronously.writeFile
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic FileSystem writeFileBlocking(String path, Buffer data)
FileSystem
FileSystem.writeFile(String, Buffer, Handler)
writeFileBlocking
in interface FileSystem
public FileSystem open(String path, OpenOptions options, Handler<AsyncResult<AsyncFile>> handler)
FileSystem
path
, asynchronously.
The file is opened for both reading and writing. If the file does not already exist it will be created.
open
in interface FileSystem
path
- path to the fileoptions
- options describing how the file should be openedpublic AsyncFile openBlocking(String path, OpenOptions options)
FileSystem
FileSystem.open(String, io.vertx.core.file.OpenOptions, Handler)
openBlocking
in interface FileSystem
public FileSystem createFile(String path, Handler<AsyncResult<Void>> handler)
FileSystem
path
, asynchronously.createFile
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic FileSystem createFileBlocking(String path)
FileSystem
FileSystem.createFile(String, Handler)
createFileBlocking
in interface FileSystem
public FileSystem createFile(String path, String perms, Handler<AsyncResult<Void>> handler)
FileSystem
path
and permissions perms
, asynchronously.createFile
in interface FileSystem
path
- path to the fileperms
- the permissions stringhandler
- the handler that will be called on completionpublic FileSystem createFileBlocking(String path, String perms)
FileSystem
FileSystem.createFile(String, String, Handler)
createFileBlocking
in interface FileSystem
public FileSystem exists(String path, Handler<AsyncResult<Boolean>> handler)
FileSystem
path
exists, asynchronously.exists
in interface FileSystem
path
- path to the filehandler
- the handler that will be called on completionpublic boolean existsBlocking(String path)
FileSystem
FileSystem.exists(String, Handler)
existsBlocking
in interface FileSystem
public FileSystem fsProps(String path, Handler<AsyncResult<FileSystemProps>> handler)
FileSystem
path
, asynchronously.fsProps
in interface FileSystem
path
- path to anywhere on the filesystemhandler
- the handler that will be called on completionpublic FileSystemProps fsPropsBlocking(String path)
FileSystem
FileSystem.fsProps(String, Handler)
fsPropsBlocking
in interface FileSystem
protected FileSystemImpl.BlockingAction<Void> chmodInternal(String path, String perms, String dirPerms, Handler<AsyncResult<Void>> handler)
protected FileSystemImpl.BlockingAction<Void> chownInternal(String path, String user, String group, Handler<AsyncResult<Void>> handler)
protected FileSystemImpl.BlockingAction<Void> mkdirInternal(String path, String perms, boolean createParents, Handler<AsyncResult<Void>> handler)
protected AsyncFile doOpen(String path, OpenOptions options, ContextImpl context)
protected FileSystemImpl.BlockingAction<Void> createFileInternal(String p, String perms, Handler<AsyncResult<Void>> handler)
Copyright © 2015. All Rights Reserved.