public abstract class FilePath extends Object
java.nio.file.Path
,
but simpler, and works with older versions of Java. It also implements the
relevant methods found in java.nio.file.FileSystem
and
FileSystems
Modifier and Type | Field and Description |
---|---|
protected String |
name
The complete path (which may be absolute or relative, depending on the
file system).
|
Constructor and Description |
---|
FilePath() |
Modifier and Type | Method and Description |
---|---|
abstract boolean |
canWrite()
Check if the file is writable.
|
abstract void |
createDirectory()
Create a directory (all required parent directories already exist).
|
abstract boolean |
createFile()
Create a new file.
|
FilePath |
createTempFile(String suffix,
boolean deleteOnExit,
boolean inTempDir)
Create a new temporary file.
|
abstract void |
delete()
Delete a file or directory if it exists.
|
abstract boolean |
exists()
Checks if a file exists.
|
static FilePath |
get(String path)
Get the file path object for the given path.
|
String |
getName()
Get the file or directory name (the last element of the path).
|
protected static String |
getNextTempFileNamePart(boolean newRandom)
Get the next temporary file name part (the part in the middle).
|
abstract FilePath |
getParent()
Get the parent directory of a file or directory.
|
abstract FilePath |
getPath(String path)
Convert a file to a path.
|
abstract String |
getScheme()
Get the scheme (prefix) for this file provider.
|
abstract boolean |
isAbsolute()
Check if the file name includes a path.
|
abstract boolean |
isDirectory()
Check if it is a file or a directory.
|
abstract long |
lastModified()
Get the last modified date of a file
|
abstract void |
moveTo(FilePath newName)
Rename a file if this is allowed.
|
abstract List<FilePath> |
newDirectoryStream()
List the files and directories in the given directory.
|
abstract InputStream |
newInputStream()
Create an input stream to read from the file.
|
abstract OutputStream |
newOutputStream(boolean append)
Create an output stream to write into the file.
|
abstract FileChannel |
open(String mode)
Open a random access file object.
|
static void |
register(FilePath provider)
Register a file provider.
|
abstract boolean |
setReadOnly()
Disable the ability to write.
|
abstract long |
size()
Get the size of a file in bytes
|
abstract FilePath |
toRealPath()
Normalize a file name.
|
String |
toString()
Get the string representation.
|
static void |
unregister(FilePath provider)
Unregister a file provider.
|
FilePath |
unwrap()
Get the unwrapped file name (without wrapper prefixes if wrapping /
delegating file systems are used).
|
protected String name
public static FilePath get(String path)
path
- the pathpublic static void register(FilePath provider)
provider
- the file providerpublic static void unregister(FilePath provider)
provider
- the file providerpublic abstract long size()
public abstract void moveTo(FilePath newName)
newName
- the new fully qualified file namepublic abstract boolean createFile()
public abstract boolean exists()
public abstract void delete()
public abstract List<FilePath> newDirectoryStream()
public abstract FilePath toRealPath()
public abstract FilePath getParent()
public abstract boolean isDirectory()
public abstract boolean isAbsolute()
public abstract long lastModified()
public abstract boolean canWrite()
public abstract void createDirectory()
public String getName()
public abstract OutputStream newOutputStream(boolean append)
append
- if true, the file will grow, if false, the file will be
truncated firstpublic abstract FileChannel open(String mode) throws IOException
mode
- the access mode. Supported are r, rw, rws, rwdIOException
public abstract InputStream newInputStream() throws IOException
IOException
public abstract boolean setReadOnly()
public FilePath createTempFile(String suffix, boolean deleteOnExit, boolean inTempDir) throws IOException
suffix
- the suffixdeleteOnExit
- if the file should be deleted when the virtual
machine existsinTempDir
- if the file should be stored in the temporary directoryIOException
protected static String getNextTempFileNamePart(boolean newRandom)
newRandom
- if the random part of the filename should changepublic String toString()
public abstract String getScheme()
java.nio.file.spi.FileSystemProvider.getScheme
.public abstract FilePath getPath(String path)
java.nio.file.spi.FileSystemProvider.getPath
, but may
return an object even if the scheme doesn't match in case of the the
default file provider.path
- the pathpublic FilePath unwrap()
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.