public interface FileName extends Comparable<FileName>
FileObject
Modifier and Type | Field and Description |
---|---|
static String |
ROOT_PATH
The absolute path of the root of a file system.
|
static 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 |
---|---|
String |
getBaseName()
Returns the base name of this file.
|
int |
getDepth()
Returns the depth of this file name, within its file system.
|
String |
getExtension()
Returns the extension of this file name.
|
String |
getFriendlyURI()
returns a "friendly path", this is a path without a password.
This path can not be used to resolve the path again |
FileName |
getParent()
Returns the file name of the parent of this file.
|
String |
getPath()
Returns the absolute path of this file, within its file system.
|
String |
getPathDecoded()
Returns the absolute path of this file, within its file system.
|
String |
getRelativeName(FileName name)
Converts a file name to a relative name, relative to this file name.
|
FileName |
getRoot()
find the root of the filesystem.
|
String |
getRootURI()
Returns the root URI of the file system this file belongs to.
|
String |
getScheme()
Returns the URI scheme of this file.
|
FileType |
getType()
Returns the requested or current type of this name.
|
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.
|
compareTo
static final char SEPARATOR_CHAR
static final String SEPARATOR
static final String ROOT_PATH
String getBaseName()
/somefolder/somefile
is somefile
.
The root file of a file system has an empty base name.
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.
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.
getPath()
the path is decoded i.e. all %nn stuff
replaced by its character.FileSystemException
- if the path is not correctly encodedString getExtension()
int getDepth()
String getScheme()
String getURI()
String getRootURI()
FileName getRoot()
FileName getParent()
FileName
object representing the parent name. Returns
null for the root of a file system.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.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
String getFriendlyURI()
Copyright © 2002–2015 The Apache Software Foundation. All rights reserved.