public class File
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
File.Result
File module result object
|
Modifier | Constructor and Description |
---|---|
private |
File() |
Modifier and Type | Method and Description |
---|---|
static LocalCall<java.lang.String> |
chmod(java.lang.String path,
java.lang.String mode)
Set the mode of a file
|
static LocalCall<java.lang.String> |
chown(java.lang.String path,
java.lang.String user,
java.lang.String group)
Chown a file
|
static LocalCall<java.lang.Boolean> |
copy(java.lang.String src,
java.lang.String dst,
boolean recurse,
boolean removeExisting)
Copy a file or directory from src to dst
|
static LocalCall<java.lang.Boolean> |
directoryExists(java.lang.String path)
Tests to see if path is a valid directory
|
static LocalCall<java.lang.Boolean> |
fileExists(java.lang.String path)
Tests to see if path is a valid file
|
static LocalCall<java.lang.String> |
getHash(java.lang.String path)
Get the hash sum of a file
|
static LocalCall<java.lang.String> |
getHash(java.lang.String path,
HashType form)
Get the hash sum of a file
|
static LocalCall<java.lang.String> |
getHash(java.lang.String path,
HashType form,
long chunkSize)
Get the hash sum of a file
|
private static LocalCall<java.lang.String> |
getHash(java.lang.String path,
java.util.Optional<HashType> form,
java.util.Optional<java.lang.Long> chunkSize) |
static LocalCall<java.lang.String> |
getMode(java.lang.String path,
boolean followSymlinks)
Return the mode of a file
|
static LocalCall<java.lang.String> |
getUid(java.lang.String path,
boolean followSymlinks)
Return the id of the user that owns a given file
|
static LocalCall<java.lang.String> |
getUser(java.lang.String path,
boolean followSymlinks)
Return the user that owns a given file
|
static LocalCall<java.lang.Boolean> |
isLink(java.lang.String path)
Check if the path is a symbolic link
|
static LocalCall<java.lang.String> |
mkdir(java.lang.String path)
Ensures that a directory is available
|
private static LocalCall<java.lang.String> |
mkdir(java.lang.String path,
java.util.Optional<java.lang.String> user,
java.util.Optional<java.lang.String> group,
java.util.Optional<java.lang.String> mode) |
static LocalCall<java.lang.String> |
mkdir(java.lang.String path,
java.lang.String mode)
Ensures that a directory is available
|
static LocalCall<java.lang.String> |
mkdir(java.lang.String path,
java.lang.String user,
java.lang.String group)
Ensures that a directory is available
|
static LocalCall<java.lang.String> |
mkdir(java.lang.String path,
java.lang.String user,
java.lang.String group,
java.lang.String mode)
Ensures that a directory is available
|
static LocalCall<File.Result> |
move(java.lang.String src,
java.lang.String dst)
Move a file or directory from src to dst
|
static LocalCall<java.util.List<java.lang.String>> |
readdir(java.lang.String path)
Returns a list containing the contents of a directory
|
static LocalCall<java.lang.Boolean> |
remove(java.lang.String path)
Remove a file
|
static LocalCall<java.lang.Boolean> |
rmdir(java.lang.String path)
Removes the specified directory
|
static LocalCall<java.lang.Boolean> |
symlink(java.lang.String src,
java.lang.String path)
Create a symbolic link (symlink, soft link) to a file
|
public static LocalCall<java.lang.String> chown(java.lang.String path, java.lang.String user, java.lang.String group)
path
- Path to the file or directoryuser
- User ownergroup
- Group ownerLocalCall
object to make the callpublic static LocalCall<java.lang.String> chmod(java.lang.String path, java.lang.String mode)
path
- File or directory of which to set the modemode
- Mode to set the path toLocalCall
object to make the callpublic static LocalCall<java.lang.Boolean> copy(java.lang.String src, java.lang.String dst, boolean recurse, boolean removeExisting)
src
- File or directory to copydst
- Destination pathrecurse
- Recurse flagremoveExisting
- If true, all files in the target directory are removed,
and then the files are copied from the sourceLocalCall
object to make the callpublic static LocalCall<File.Result> move(java.lang.String src, java.lang.String dst)
src
- File or directory to copydst
- Destination pathLocalCall
object to make the callpublic static LocalCall<java.lang.Boolean> remove(java.lang.String path)
path
- File path to removeLocalCall
object to make the callpublic static LocalCall<java.lang.String> getHash(java.lang.String path)
SHA256 algorithm is used by default
path
- Path to the file or directoryLocalCall
object to make the callpublic static LocalCall<java.lang.String> getHash(java.lang.String path, HashType form)
path
- Path to the file or directoryform
- Desired sum formatLocalCall
object to make the callpublic static LocalCall<java.lang.String> getHash(java.lang.String path, HashType form, long chunkSize)
path
- Path to the file or directoryform
- Desired sum formatchunkSize
- Amount to sum at onceLocalCall
object to make the callprivate static LocalCall<java.lang.String> getHash(java.lang.String path, java.util.Optional<HashType> form, java.util.Optional<java.lang.Long> chunkSize)
public static LocalCall<java.lang.Boolean> directoryExists(java.lang.String path)
path
- Path to directoryLocalCall
object to make the callpublic static LocalCall<java.lang.Boolean> fileExists(java.lang.String path)
path
- Path to fileLocalCall
object to make the callpublic static LocalCall<java.lang.String> getMode(java.lang.String path, boolean followSymlinks)
path
- File or directory of which to get the modefollowSymlinks
- Indicated if symlinks should be followedLocalCall
object to make the callpublic static LocalCall<java.lang.String> getUid(java.lang.String path, boolean followSymlinks)
path
- File or directory of which to get the uid ownerfollowSymlinks
- Indicated if symlinks should be followedLocalCall
object to make the callpublic static LocalCall<java.lang.String> getUser(java.lang.String path, boolean followSymlinks)
path
- File or directory of which to get the user ownerfollowSymlinks
- Indicated if symlinks should be followedLocalCall
object to make the callpublic static LocalCall<java.lang.String> mkdir(java.lang.String path)
path
- Path to directoryLocalCall
object to make the callpublic static LocalCall<java.lang.String> mkdir(java.lang.String path, java.lang.String mode)
path
- Path to directorymode
- Mode for the newly created directoryLocalCall
object to make the callpublic static LocalCall<java.lang.String> mkdir(java.lang.String path, java.lang.String user, java.lang.String group)
path
- Path to directoryuser
- Owner usergroup
- Owner groupLocalCall
object to make the callpublic static LocalCall<java.lang.String> mkdir(java.lang.String path, java.lang.String user, java.lang.String group, java.lang.String mode)
path
- Path to directoryuser
- Owner usergroup
- Owner groupmode
- Mode for the newly created directoryLocalCall
object to make the callprivate static LocalCall<java.lang.String> mkdir(java.lang.String path, java.util.Optional<java.lang.String> user, java.util.Optional<java.lang.String> group, java.util.Optional<java.lang.String> mode)
public static LocalCall<java.util.List<java.lang.String>> readdir(java.lang.String path)
path
- Path to directoryLocalCall
object to make the callpublic static LocalCall<java.lang.Boolean> rmdir(java.lang.String path)
Fails if the directory is not empty
path
- Path to directoryLocalCall
object to make the callpublic static LocalCall<java.lang.Boolean> isLink(java.lang.String path)
path
- Path to file or directoryLocalCall
object to make the call