FileName

All Superinterfaces:

java.lang.Comparable

All Known Implementing Classes:

AbstractFileName, GenericFileName, LayeredFileName, LocalFileName, UrlFileName, URLFileName, VirtualFileName, WindowsFileName
```
public interface FileName
extends java.lang.Comparable
```
Represents a file name. File names are immutable, and work correctly as keys in hash tables.

Version:

$Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Wed, 29 Nov 2006) $

Author:

Adam Murdoch

See Also:

FileObject

Field Summary

Fields
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.

Method Summary

All Methods Instance Methods Abstract Methods
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. This path can not be used to resolve the path again
`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()` find the root of the filesystem
`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.

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - SEPARATOR_CHAR
```
static final char SEPARATOR_CHAR
```
    The separator character used in file paths.
    
    See Also:
    
    Constant Field Values
  - SEPARATOR
```
static final java.lang.String SEPARATOR
```
    The separator used in file paths.
    
    See Also:
    
    Constant Field Values
  - ROOT_PATH
```
static final java.lang.String ROOT_PATH
```
    The absolute path of the root of a file system.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getBaseName
```
java.lang.String getBaseName()
```
    Returns the base name of this file. The base name is the last element of the file name. For example the base name of /somefolder/somefile is somefile.
    
    The root file of a file system has an empty base name.
    
    Returns:
    
    The base name. Never returns null.
  - getPath
```
java.lang.String getPath()
```
    Returns the absolute path of this file, within its file system. This path is normalised, 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.
  - getPathDecoded
```
java.lang.String getPathDecoded()
                         throws FileSystemException
```
    Returns the absolute path of this file, within its file system. This path is normalised, 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() the path is decoded i.e. all %nn stuff replaced by its character.
    
    Returns:
    
    The path. Never returns null.
    
    Throws:
    
    FileSystemException - if the path is not correctly encoded
  - getExtension
```
java.lang.String getExtension()
```
    Returns the extension of this file name.
    
    Returns:
    
    The extension. Returns an empty string if the name has no extension.
  - getDepth
```
int getDepth()
```
    Returns 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.
  - getScheme
```
java.lang.String getScheme()
```
    Returns the URI scheme of this file.
  - getURI
```
java.lang.String getURI()
```
    Returns the absolute URI of this file.
  - getRootURI
```
java.lang.String getRootURI()
```
    Returns the root URI of the file system this file belongs to.
  - getRoot
```
FileName getRoot()
```
    find the root of the filesystem
  - getParent
```
FileName getParent()
```
    Returns the file name of the parent of this file. The root of a file system has no parent.
    
    Returns:
    
    A FileName object representing the parent name. Returns null for the root of a file system.
  - getRelativeName
```
java.lang.String getRelativeName(FileName name)
                          throws FileSystemException
```
    Converts 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.
  - isAncestor
```
boolean isAncestor(FileName ancestor)
```
    Determines if another file name is an ancestor of this file name.
  - isDescendent
```
boolean isDescendent(FileName descendent)
```
    Determines if another file name is a descendent of this file name.
  - isDescendent
```
boolean isDescendent(FileName descendent,
                     NameScope nameScope)
```
    Determines if another file name is a descendent of this file name.
  - getType
```
FileType getType()
```
    Returns 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.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.
    
    Returns:
    
    FileType.FOLDER or FileType.FILE
  - getFriendlyURI
```
java.lang.String getFriendlyURI()
```
    returns a "friendly path", this is a path without a password.
    This path can not be used to resolve the path again

Interface FileName

Field Summary

Method Summary

Methods inherited from interface java.lang.Comparable

Field Detail

SEPARATOR_CHAR

SEPARATOR

ROOT_PATH

Method Detail

getBaseName

getPath

getPathDecoded

getExtension

getDepth

getScheme

getURI

getRootURI

getRoot

getParent

getRelativeName

isAncestor

isDescendent

isDescendent

getType

getFriendlyURI