Package org.apache.commons.vfs2
Interface FileName
- All Superinterfaces:
- Comparable<FileName>
- All Known Implementing Classes:
- AbstractFileName,- GenericFileName,- GenericURLFileName,- LayeredFileName,- LocalFileName,- ResourceFileName,- UrlFileName,- URLFileName,- VirtualFileName,- WindowsFileName
Represents a file name. File names are immutable, and work correctly as keys in hash tables.
- See Also:
- 
Field SummaryFields
- 
Method SummaryModifier and TypeMethodDescriptionGets the base name of this file.intgetDepth()Gets the depth of this file name, within its file system.Gets the extension of this file name.Gets a "friendly path", this is a path without a password.Gets the file name of the parent of this file.getPath()Gets the absolute path string of this file, within its file system.Returns the absolute path of this file, within its file system.getRelativeName(FileName name) Converts a file name to a relative name, relative to this file name.getRoot()Gets the root of the file system.Gets the root URI string of the file system this file belongs to.Gets the URI scheme of this file.getType()Gets the requested or current type of this name.getURI()Gets the absolute URI string of this file.booleanisAncestor(FileName ancestor) Tests if another file name is an ancestor of this file name.booleanisDescendent(FileName descendent) Tests if another file name is a descendent of this file name.booleanisDescendent(FileName descendent, NameScope nameScope) Tests if another file name is a descendent of this file name.booleanisFile()Tests if this file name is a name for a regular file.Methods inherited from interface java.lang.ComparablecompareTo
- 
Field Details- 
SEPARATOR_CHARThe separator character used in file paths.- See Also:
 
- 
SEPARATORThe separator used in file paths.- See Also:
 
- 
ROOT_PATHThe absolute path of the root of a file system.- See Also:
 
- 
EMPTY_ARRAYEmpty array of FileName.- Since:
- 2.8.0
 
 
- 
- 
Method Details- 
getBaseNameGets the base name of this file. The base name is the last element of the file name. For example the base name of/somefolder/somefileissomefile.The root file of a file system has an empty base name. - Returns:
- The base name. Never returns null.
 
- 
getDepthint getDepth()Gets the depth of this file name, within its file system. The depth of the root of a file system is 0. The depth of any other file is 1 + the depth of its parent.- Returns:
- The depth of this file name.
 
- 
getExtensionGets the extension of this file name.- Returns:
- The extension. Returns an empty string if the name has no extension.
 
- 
getFriendlyURIGets a "friendly path", this is a path without a password.This path cannot be used to resolve the path again. - Returns:
- the friendly URI as a String.
 
- 
getParentGets the file name of the parent of this file. The root of a file system has no parent.- Returns:
- A FileNameobject representing the parent name. Returns null for the root of a file system.
 
- 
getPathGets the absolute path string of this file, within its file system. This path is normalized, so that.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.- Returns:
- The path. Never returns null.
 
- 
getPathDecodedReturns the absolute path of this file, within its file system. This path is normalized, so that.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(), this path is decoded: All %nn escapes are replaced by their respective characters.- Returns:
- The decoded path. Never returns null.
- Throws:
- FileSystemException- if the path is not correctly encoded
 
- 
getRelativeNameConverts a file name to a relative name, relative to this file name.- Parameters:
- name- The name to convert to a relative path.
- Returns:
- The relative name.
- Throws:
- FileSystemException- On error.
 
- 
getRootGets the root of the file system.- Returns:
- the file system root.
 
- 
getRootURIGets the root URI string of the file system this file belongs to.- Returns:
- the root URI string.
 
- 
getSchemeGets the URI scheme of this file.- Returns:
- The URI scheme of this file.
 
- 
getTypeGets the requested or current type of this name.The "requested" type is the one determined during resolving the name. In this case the name is a FileType.FOLDERif it ends with an "/" else it will be aFileType.FILE.Once attached it will be changed to reflect the real type of this resource. - Returns:
- FileType.FOLDERor- FileType.FILE
 
- 
getURIGets the absolute URI string of this file.- Returns:
- the absolute URI string of this file.
 
- 
isAncestorTests if another file name is an ancestor of this file name.- Parameters:
- ancestor- The FileName to check.
- Returns:
- true if another file name is an ancestor of this file name.
 
- 
isDescendentTests if another file name is a descendent of this file name.- Parameters:
- descendent- the FileName to check.
- Returns:
- true if the other FileName is a descendent of this file name.
 
- 
isDescendentTests if another file name is a descendent of this file name.- Parameters:
- descendent- the FileName to check.
- nameScope- the NameScope of the FileName.
- Returns:
- true if the other FileName is a descendent of this file name.
 
- 
isFileTests if this file name is a name for a regular file.- Returns:
- true if this file name is a name for a regular file.
- Throws:
- FileSystemException- if an error occurs.
- Since:
- 2.1
- See Also:
 
 
-