AbstractFileName (Apache Commons VFS 2.9.0 API)

java.lang.Object
- org.apache.commons.vfs2.provider.AbstractFileName

All Implemented Interfaces:

Comparable<FileName>, FileName

Direct Known Subclasses:

GenericFileName, LayeredFileName, LocalFileName, ResourceFileName, VirtualFileName
```
public abstract class AbstractFileName
extends Object
implements FileName
```
A default file name implementation.

Field Summary
- Fields inherited from interface org.apache.commons.vfs2.FileName
  EMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors
Constructor and Description

AbstractFileName(String scheme, String absPath, FileType type)

Constructors
Constructor and Description
`AbstractFileName(String scheme, String absPath, FileType type)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`appendRootUri(StringBuilder buffer, boolean addPassword)` Builds the root URI for this file name.
`static boolean`	`checkName(String basePath, String path, NameScope scope)` Checks whether a path fits in a particular scope of another path.
`int`	`compareTo(FileName obj)` Implement Comparable.
`abstract FileName`	`createName(String absolutePath, FileType fileType)` Factory method for creating name instances.
`protected String`	`createURI()`
`boolean`	`equals(Object o)`
`String`	`getBaseName()` Returns the base name of the 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 the URI without a password.
`FileName`	`getParent()` Returns the name of the parent of the file.
`String`	`getPath()` Returns the absolute path of the file, relative to the root of the file system that the file belongs to.
`String`	`getPathDecoded()` Returns the decoded path.
`String`	`getRelativeName(FileName name)` Converts a file name to a relative name, relative to this file name.
`FileName`	`getRoot()` find the root of the file system.
`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 the file.
`protected String`	`getUriTrailer()`
`int`	`hashCode()`
`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 scope)` 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 by using its type.
`String`	`toString()` Returns the URI of the file.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractFileName
```
public AbstractFileName(String scheme,
                        String absPath,
                        FileType type)
```
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(FileName obj)
```
    Implement Comparable.
    
    Specified by:
    
    compareTo in interface Comparable<FileName>
    
    Parameters:
    
    obj - another abstract file name
    
    Returns:
    
    negative number if less than, 0 if equal, positive if greater than.
  - toString
```
public String toString()
```
    Returns the URI of the file.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the FileName as a URI.
  - createName
```
public abstract FileName createName(String absolutePath,
                                    FileType fileType)
```
    Factory method for creating name instances.
    
    Parameters:
    
    absolutePath - The absolute path.
    
    fileType - The FileType.
    
    Returns:
    
    The FileName.
  - appendRootUri
```
protected abstract void appendRootUri(StringBuilder buffer,
                                      boolean addPassword)
```
    Builds 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.
  - getBaseName
```
public String getBaseName()
```
    Returns the base name of the file.
    
    Specified by:
    
    getBaseName in interface FileName
    
    Returns:
    
    The base name of the file.
  - getPath
```
public String getPath()
```
    Returns the absolute path of the file, relative to the root of the file system that the file belongs to.
    
    Specified by:
    
    getPath in interface FileName
    
    Returns:
    
    The path String.
  - getUriTrailer
```
protected String getUriTrailer()
```
  - getPathDecoded
```
public String getPathDecoded()
                      throws FileSystemException
```
    Returns the decoded path.
    
    Specified by:
    
    getPathDecoded in interface FileName
    
    Returns:
    
    The decoded path String.
    
    Throws:
    
    FileSystemException - If an error occurs.
  - getParent
```
public FileName getParent()
```
    Returns the name of the parent of the file.
    
    Specified by:
    
    getParent in interface FileName
    
    Returns:
    
    the FileName of the parent.
  - getRoot
```
public FileName getRoot()
```
    find the root of the file system.
    
    Specified by:
    
    getRoot in interface FileName
    
    Returns:
    
    The root FileName.
  - getScheme
```
public String getScheme()
```
    Returns the URI scheme of this file.
    
    Specified by:
    
    getScheme in interface FileName
    
    Returns:
    
    The protocol used to access the file.
  - getURI
```
public String getURI()
```
    Returns the absolute URI of the file.
    
    Specified by:
    
    getURI in interface FileName
    
    Returns:
    
    The absolute URI of the file.
  - createURI
```
protected String createURI()
```
  - getFriendlyURI
```
public String getFriendlyURI()
```
    Returns the URI without a password.
    
    Specified by:
    
    getFriendlyURI in interface FileName
    
    Returns:
    
    Returns the URI without a password.
  - getRelativeName
```
public String getRelativeName(FileName name)
                       throws FileSystemException
```
    Converts a file name to a relative name, relative to this file name.
    
    Specified by:
    
    getRelativeName in interface FileName
    
    Parameters:
    
    name - The FileName.
    
    Returns:
    
    The relative path to the file.
    
    Throws:
    
    FileSystemException - if an error occurs.
  - getRootURI
```
public String getRootURI()
```
    Returns the root URI of the file system this file belongs to.
    
    Specified by:
    
    getRootURI in interface FileName
    
    Returns:
    
    The URI of the root.
  - getDepth
```
public int getDepth()
```
    Returns the depth of this file name, within its file system.
    
    Specified by:
    
    getDepth in interface FileName
    
    Returns:
    
    The depth of the file name.
  - getExtension
```
public String getExtension()
```
    Returns the extension of this file name.
    
    Specified by:
    
    getExtension in interface FileName
    
    Returns:
    
    The file extension.
  - isAncestor
```
public boolean isAncestor(FileName ancestor)
```
    Determines if another file name is an ancestor of this file name.
    
    Specified by:
    
    isAncestor in interface FileName
    
    Parameters:
    
    ancestor - The FileName to check.
    
    Returns:
    
    true if the FileName is an ancestor, false otherwise.
  - isDescendent
```
public boolean isDescendent(FileName descendent)
```
    Determines if another file name is a descendent of this file name.
    
    Specified by:
    
    isDescendent in interface FileName
    
    Parameters:
    
    descendent - The FileName to check.
    
    Returns:
    
    true if the FileName is a descendent, false otherwise.
  - isDescendent
```
public boolean isDescendent(FileName descendent,
                            NameScope scope)
```
    Determines if another file name is a descendent of this file name.
    
    Specified by:
    
    isDescendent in interface FileName
    
    Parameters:
    
    descendent - The FileName to check.
    
    scope - The NameScope.
    
    Returns:
    
    true if the FileName is a descendent, false otherwise.
  - isFile
```
public boolean isFile()
               throws FileSystemException
```
    Checks if this file name is a name for a regular file by using its type.
    
    Specified by:
    
    isFile in interface FileName
    
    Returns:
    
    true if this file is a regular file.
    
    Throws:
    
    FileSystemException - may be thrown by subclasses.
    
    See Also:
    
    getType(), FileType.FILE
  - getType
```
public FileType getType()
```
    Returns 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.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.
    
    Specified by:
    
    getType in interface FileName
    
    Returns:
    
    FileType.FOLDER or FileType.FILE
  - checkName
```
public static boolean checkName(String basePath,
                                String path,
                                NameScope scope)
```
    Checks whether a path fits in a particular scope of another path.
    
    Parameters:
    
    basePath - An absolute, normalised path.
    
    path - An absolute, normalised path.
    
    scope - The NameScope.
    
    Returns:
    
    true if the path fits in the scope, false otherwise.

Class AbstractFileName

Field Summary

Fields inherited from interface org.apache.commons.vfs2.FileName

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractFileName

Method Detail

equals

hashCode

compareTo

toString

createName

appendRootUri

getBaseName

getPath

getUriTrailer

getPathDecoded

getParent

getRoot

getScheme

getURI

createURI

getFriendlyURI

getRelativeName

getRootURI

getDepth

getExtension

isAncestor

isDescendent

isDescendent

isFile

getType

checkName