Package org.apache.commons.vfs2.provider
Class AbstractFileName
java.lang.Object
org.apache.commons.vfs2.provider.AbstractFileName
- All Implemented Interfaces:
- Comparable<FileName>,- FileName
- Direct Known Subclasses:
- GenericFileName,- LayeredFileName,- LocalFileName,- ResourceFileName,- VirtualFileName
A default file name implementation.
- 
Field SummaryFields inherited from interface org.apache.commons.vfs2.FileNameEMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR
- 
Constructor SummaryConstructorsConstructorDescriptionAbstractFileName(String scheme, String absolutePath, FileType type) Constructs a new instance for subclasses.
- 
Method SummaryModifier and TypeMethodDescriptionprotected abstract voidappendRootUri(StringBuilder buffer, boolean addPassword) Builds the root URI for this file name.static booleanChecks whether a path fits in a particular scope of another path.intImplement Comparable.abstract FileNamecreateName(String absolutePath, FileType fileType) Factory method for creating name instances.protected StringCreates a URI.booleanReturns the base name of the file.intgetDepth()Returns the depth of this file name, within its file system.Returns the extension of this file name.Returns the URI without a password.Returns the name of the parent of the file.getPath()Returns the absolute path of the file, relative to the root of the file system that the file belongs to.Returns the decoded path.getRelativeName(FileName name) Converts a file name to a relative name, relative to this file name.getRoot()find the root of the file system.Returns the root URI of the file system this file belongs to.Returns the URI scheme of this file.getType()Returns the requested or current type of this name.getURI()Returns the absolute URI of the file.protected StringGets the string to end a URI.inthashCode()booleanisAncestor(FileName ancestor) Determines if another file name is an ancestor of this file name.booleanisDescendent(FileName descendent) Determines if another file name is a descendent of this file name.booleanisDescendent(FileName descendent, NameScope scope) Determines if another file name is a descendent of this file name.booleanisFile()Checks if this file name is a name for a regular file by using its type.toString()Returns the URI of the file.
- 
Constructor Details- 
AbstractFileNameConstructs a new instance for subclasses.- Parameters:
- scheme- The scheme.
- absolutePath- the absolute path, maybe empty or null.
- type- the file type.
 
 
- 
- 
Method Details- 
checkNameChecks whether a path fits in a particular scope of another path.- Parameters:
- basePath- An absolute, normalized path.
- path- An absolute, normalized path.
- scope- The NameScope.
- Returns:
- true if the path fits in the scope, false otherwise.
 
- 
appendRootUriBuilds the root URI for this file name. Note that the root URI must not end with a separator character.- Parameters:
- buffer- A StringBuilder to use to construct the URI.
- addPassword- true if the password should be added, false otherwise.
 
- 
compareToImplement Comparable.- Specified by:
- compareToin interface- Comparable<FileName>
- Parameters:
- obj- another abstract file name
- Returns:
- negative number if less than, 0 if equal, positive if greater than.
 
- 
createNameFactory method for creating name instances.- Parameters:
- absolutePath- The absolute path.
- fileType- The FileType.
- Returns:
- The FileName.
 
- 
createURICreates a URI.- Returns:
- a URI.
 
- 
equals
- 
getBaseNameReturns the base name of the file.- Specified by:
- getBaseNamein interface- FileName
- Returns:
- The base name of the file.
 
- 
getDepthReturns the depth of this file name, within its file system.
- 
getExtensionReturns the extension of this file name.- Specified by:
- getExtensionin interface- FileName
- Returns:
- The file extension.
 
- 
getFriendlyURIReturns the URI without a password.- Specified by:
- getFriendlyURIin interface- FileName
- Returns:
- Returns the URI without a password.
 
- 
getParentReturns the name of the parent of the file.
- 
getPathReturns the absolute path of the file, relative to the root of the file system that the file belongs to.
- 
getPathDecodedReturns the decoded path.- Specified by:
- getPathDecodedin interface- FileName
- Returns:
- The decoded path String.
- Throws:
- FileSystemException- If an error occurs.
 
- 
getRelativeNameConverts a file name to a relative name, relative to this file name.- Specified by:
- getRelativeNamein interface- FileName
- Parameters:
- name- The FileName.
- Returns:
- The relative path to the file.
- Throws:
- FileSystemException- if an error occurs.
 
- 
getRootfind the root of the file system.
- 
getRootURIReturns the root URI of the file system this file belongs to.- Specified by:
- getRootURIin interface- FileName
- Returns:
- The URI of the root.
 
- 
getSchemeReturns the URI scheme of this file.
- 
getTypeReturns the requested or current type of this name.The "requested" type is the one determined during resolving the name. n 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. - Specified by:
- getTypein interface- FileName
- Returns:
- FileType.FOLDERor- FileType.FILE
 
- 
getURIReturns the absolute URI of the file.
- 
getUriTrailerGets the string to end a URI.- Returns:
- the string to end a URI
 
- 
hashCode
- 
isAncestorDetermines if another file name is an ancestor of this file name.- Specified by:
- isAncestorin interface- FileName
- Parameters:
- ancestor- The FileName to check.
- Returns:
- true if the FileName is an ancestor, false otherwise.
 
- 
isDescendentDetermines if another file name is a descendent of this file name.- Specified by:
- isDescendentin interface- FileName
- Parameters:
- descendent- The FileName to check.
- Returns:
- true if the FileName is a descendent, false otherwise.
 
- 
isDescendentDetermines if another file name is a descendent of this file name.- Specified by:
- isDescendentin interface- FileName
- Parameters:
- descendent- The FileName to check.
- scope- The NameScope.
- Returns:
- true if the FileName is a descendent, false otherwise.
 
- 
isFileChecks if this file name is a name for a regular file by using its type.- Specified by:
- isFilein interface- FileName
- Returns:
- true if this file is a regular file.
- Throws:
- FileSystemException- may be thrown by subclasses.
- See Also:
 
- 
toStringReturns the URI of the file.
 
-