public interface FileName extends java.lang.Comparable<FileName>
FileObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ROOT_PATH
The absolute path of the root of a file system.
|
static java.lang.String |
SEPARATOR
The separator used in file paths.
|
static char |
SEPARATOR_CHAR
The separator character used in file paths.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBaseName()
Returns the base name of this file.
|
int |
getDepth()
Returns the depth of this file name, within its file system.
|
java.lang.String |
getExtension()
Returns the extension of this file name.
|
java.lang.String |
getFriendlyURI()
Returns a "friendly path", this is a path without a password.
|
FileName |
getParent()
Returns the file name of the parent of this file.
|
java.lang.String |
getPath()
Returns the absolute path of this file, within its file system.
|
java.lang.String |
getPathDecoded()
Returns the absolute path of this file, within its file system.
|
java.lang.String |
getRelativeName(FileName name)
Converts a file name to a relative name, relative to this file name.
|
FileName |
getRoot()
Finds the root of the file system.
|
java.lang.String |
getRootURI()
Returns the root URI of the file system this file belongs to.
|
java.lang.String |
getScheme()
Returns the URI scheme of this file.
|
FileType |
getType()
Returns the requested or current type of this name.
|
java.lang.String |
getURI()
Returns the absolute URI of this file.
|
boolean |
isAncestor(FileName ancestor)
Determines if another file name is an ancestor of this file name.
|
boolean |
isDescendent(FileName descendent)
Determines if another file name is a descendent of this file name.
|
boolean |
isDescendent(FileName descendent,
NameScope nameScope)
Determines if another file name is a descendent of this file name.
|
boolean |
isFile()
Checks if this file name is a name for a regular file.
|
static final char SEPARATOR_CHAR
static final java.lang.String SEPARATOR
static final java.lang.String ROOT_PATH
java.lang.String getBaseName()
/somefolder/somefile
is somefile
.
The root file of a file system has an empty base name.
java.lang.String getPath()
.
and
..
elements have been removed. Also, the path only contains /
as its separator character. The
path always starts with /
The root of a file system has /
as its absolute path.
java.lang.String getPathDecoded() throws FileSystemException
.
and
..
elements have been removed. Also, the path only contains /
as its separator character. The
path always starts with /
The root of a file system has /
as its absolute path.
In contrast to getPath()
the path is decoded i.e. all %nn stuff replaced by its character.
FileSystemException
- if the path is not correctly encodedjava.lang.String getExtension()
int getDepth()
java.lang.String getScheme()
java.lang.String getURI()
java.lang.String getRootURI()
FileName getRoot()
FileName getParent()
FileName
object representing the parent name. Returns null for the root of a file system.java.lang.String getRelativeName(FileName name) throws FileSystemException
name
- The name to convert to a relative path.FileSystemException
- On error.boolean isAncestor(FileName ancestor)
ancestor
- The FileName to check.boolean isDescendent(FileName descendent)
descendent
- the FileName to check.boolean isDescendent(FileName descendent, NameScope nameScope)
descendent
- the FileName to check.nameScope
- the NameScope of the FileName.boolean isFile() throws FileSystemException
FileSystemException
- if an error occurs.getType()
,
FileType.FILE
FileType getType()
The "requested" type is the one determined during resolving the name. In this case the name is a
FileType.FOLDER
if it ends with an "/" else it will be a FileType.FILE
.
Once attached it will be changed to reflect the real type of this resource.
FileType.FOLDER
or FileType.FILE
java.lang.String getFriendlyURI()
This path can not be used to resolve the path again.