FileSystem (Hadoop 1.2.2-SNAPSHOT API)

java.lang.Object
- org.apache.hadoop.conf.Configured
- - org.apache.hadoop.fs.FileSystem

所有已实现的接口:

Closeable, AutoCloseable, Configurable

直接已知子类:

DistributedFileSystem, FilterFileSystem, FTPFileSystem, HftpFileSystem, KosmosFileSystem, NativeS3FileSystem, RawLocalFileSystem, S3FileSystem, WebHdfsFileSystem
```
public abstract class FileSystem
extends Configured
implements Closeable
```
An abstract base class for a fairly generic filesystem. It may be implemented as a distributed filesystem, or as a "local" one that reflects the locally-connected disk. The local version exists for small Hadoop instances and for testing.
All user code that may potentially use the Hadoop Distributed File System should be written to use a FileSystem object. The Hadoop DFS is a multi-machine system that appears as a single disk. It's useful because of its fault tolerance and potentially very large capacity.
The local implementation is LocalFileSystem and distributed implementation is DistributedFileSystem.

嵌套类概要

嵌套类
限定符和类型类和说明

static class FileSystem.Statistics

嵌套类
限定符和类型	类和说明
`static class`	`FileSystem.Statistics`

字段概要

字段
限定符和类型	字段和说明
`static String`	`FS_DEFAULT_NAME_KEY`
`static org.apache.commons.logging.Log`	`LOG`
`protected FileSystem.Statistics`	`statistics` The statistics for this file system.

构造器概要

构造器
限定符构造器和说明

protected FileSystem()

构造器
限定符	构造器和说明
`protected`	`FileSystem()`

方法概要

方法
限定符和类型	方法和说明
`static void`	`addFileSystemForTesting(URI uri, Configuration conf, FileSystem fs)` This method adds a file system for testing so that we can find it later.
`FSDataOutputStream`	`append(Path f)` Append to an existing file (optional operation).
`FSDataOutputStream`	`append(Path f, int bufferSize)` Append to an existing file (optional operation).
`abstract FSDataOutputStream`	`append(Path f, int bufferSize, Progressable progress)` Append to an existing file (optional operation).
`protected void`	`checkPath(Path path)` Check that a Path belongs to this FileSystem.
`static void`	`clearStatistics()`
`void`	`close()` No more filesystem operations are needed.
`static void`	`closeAll()` Close all cached filesystems.
`static void`	`closeAllForUGI(UserGroupInformation ugi)` Close all cached filesystems for a given UGI.
`void`	`completeLocalOutput(Path fsOutputFile, Path tmpLocalFile)` Called when we're all done writing to the target.
`void`	`concat(Path trg, Path[] srcs)` Concat existing files together.
`void`	`copyFromLocalFile(boolean delSrc, boolean overwrite, Path[] srcs, Path dst)` The src files are on the local disk.
`void`	`copyFromLocalFile(boolean delSrc, boolean overwrite, Path src, Path dst)` The src file is on the local disk.
`void`	`copyFromLocalFile(boolean delSrc, Path src, Path dst)` The src file is on the local disk.
`void`	`copyFromLocalFile(Path src, Path dst)` The src file is on the local disk.
`void`	`copyToLocalFile(boolean delSrc, Path src, Path dst)` The src file is under FS, and the dst is on the local disk.
`void`	`copyToLocalFile(Path src, Path dst)` The src file is under FS, and the dst is on the local disk.
`static FSDataOutputStream`	`create(FileSystem fs, Path file, FsPermission permission)` create a file with the provided permission The permission of the file is set to be the provided permission as in setPermission, not permission&~umask It is implemented using two RPCs.
`FSDataOutputStream`	`create(Path f)` Opens an FSDataOutputStream at the indicated Path.
`FSDataOutputStream`	`create(Path f, boolean overwrite)` Opens an FSDataOutputStream at the indicated Path.
`FSDataOutputStream`	`create(Path f, boolean overwrite, int bufferSize)` Opens an FSDataOutputStream at the indicated Path.
`FSDataOutputStream`	`create(Path f, boolean overwrite, int bufferSize, Progressable progress)` Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
`FSDataOutputStream`	`create(Path f, boolean overwrite, int bufferSize, short replication, long blockSize)` Opens an FSDataOutputStream at the indicated Path.
`FSDataOutputStream`	`create(Path f, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
`abstract FSDataOutputStream`	`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
`FSDataOutputStream`	`create(Path f, Progressable progress)` Create an FSDataOutputStream at the indicated Path with write-progress reporting.
`FSDataOutputStream`	`create(Path f, short replication)` Opens an FSDataOutputStream at the indicated Path.
`FSDataOutputStream`	`create(Path f, short replication, Progressable progress)` Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
`boolean`	`createNewFile(Path f)` Creates the given Path as a brand-new zero-length file.
`FSDataOutputStream`	`createNonRecursive(Path f, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` 已过时。 API only for 0.20-append
`FSDataOutputStream`	`createNonRecursive(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` 已过时。 API only for 0.20-append
`abstract boolean`	`delete(Path f)` 已过时。 Use delete(Path, boolean) instead
`abstract boolean`	`delete(Path f, boolean recursive)` Delete a file.
`boolean`	`deleteOnExit(Path f)` Mark a path to be deleted when FileSystem is closed.
`boolean`	`exists(Path f)` Check if exists.
`static FileSystem`	`get(Configuration conf)` Returns the configured filesystem implementation.
`static FileSystem`	`get(URI uri, Configuration conf)` Returns the FileSystem for this URI's scheme and authority.
`static FileSystem`	`get(URI uri, Configuration conf, String user)`
`static List<FileSystem.Statistics>`	`getAllStatistics()` Return the FileSystem classes that have Statistics
`long`	`getBlockSize(Path f)` 已过时。 Use getFileStatus() instead
`static int`	`getCacheSize()` Get the number of entries in the filesystem cache
`String`	`getCanonicalServiceName()` Get a canonical service name for this file system.
`protected URI`	`getCanonicalUri()` Resolve the uri's hostname and add the default port if not in the uri
`ContentSummary`	`getContentSummary(Path f)` Return the `ContentSummary` of a given `Path`.
`long`	`getDefaultBlockSize()` 已过时。 use `getDefaultBlockSize(Path)` instead
`long`	`getDefaultBlockSize(Path f)` Return the number of bytes that large input files should be optimally be split into to minimize i/o time.
`protected int`	`getDefaultPort()` Get the default port for this file system.
`short`	`getDefaultReplication()` 已过时。 use `getDefaultReplication(Path)` instead
`short`	`getDefaultReplication(Path path)` Get the default replication.
`static URI`	`getDefaultUri(Configuration conf)` Get the default filesystem URI from a configuration.
`Token<?>`	`getDelegationToken(String renewer)` Get a new delegation token for this file system.
`BlockLocation[]`	`getFileBlockLocations(FileStatus file, long start, long len)` Return an array containing hostnames, offset and size of portions of the given file.
`FileChecksum`	`getFileChecksum(Path f)` Get the checksum of a file.
`abstract FileStatus`	`getFileStatus(Path f)` Return a file status object that represents the path.
`Path`	`getHomeDirectory()` Return the current user's home directory in this filesystem.
`long`	`getLength(Path f)` 已过时。 Use getFileStatus() instead
`static LocalFileSystem`	`getLocal(Configuration conf)` Get the local file syste
`String`	`getName()` 已过时。 call #getUri() instead.
`static FileSystem`	`getNamed(String name, Configuration conf)` 已过时。 call #get(URI,Configuration) instead.
`short`	`getReplication(Path src)` 已过时。 Use getFileStatus() instead
`static Map<String,FileSystem.Statistics>`	`getStatistics()` 已过时。 use `getAllStatistics()` instead
`static FileSystem.Statistics`	`getStatistics(String scheme, Class<? extends FileSystem> cls)` Get the statistics for a particular file system
`abstract URI`	`getUri()` Returns a URI whose scheme and authority identify this FileSystem.
`long`	`getUsed()` Return the total size of all files in the filesystem.
`abstract Path`	`getWorkingDirectory()` Get the current working directory for the given file system
`FileStatus[]`	`globStatus(Path pathPattern)` Return all the files that match filePattern and are not checksum files.
`FileStatus[]`	`globStatus(Path pathPattern, PathFilter filter)` Return an array of FileStatus objects whose path names match pathPattern and is accepted by the user-supplied path filter.
`void`	`initialize(URI name, Configuration conf)` Called after a new FileSystem instance is constructed.
`boolean`	`isDirectory(Path f)` 已过时。 Use getFileStatus() instead
`boolean`	`isFile(Path f)` True iff the named path is a regular file.
`abstract FileStatus[]`	`listStatus(Path f)` List the statuses of the files/directories in the given path if the path is a directory.
`FileStatus[]`	`listStatus(Path[] files)` Filter files/directories in the given list of paths using default path filter.
`FileStatus[]`	`listStatus(Path[] files, PathFilter filter)` Filter files/directories in the given list of paths using user-supplied path filter.
`FileStatus[]`	`listStatus(Path f, PathFilter filter)` Filter files/directories in the given path using the user-supplied path filter.
`Path`	`makeQualified(Path path)` Make sure that a path specifies a FileSystem.
`static boolean`	`mkdirs(FileSystem fs, Path dir, FsPermission permission)` create a directory with the provided permission The permission of the directory is set to be the provided permission as in setPermission, not permission&~umask
`boolean`	`mkdirs(Path f)` Call `mkdirs(Path, FsPermission)` with default permission.
`abstract boolean`	`mkdirs(Path f, FsPermission permission)` Make the given file and all non-existent parents into directories.
`void`	`moveFromLocalFile(Path[] srcs, Path dst)` The src files is on the local disk.
`void`	`moveFromLocalFile(Path src, Path dst)` The src file is on the local disk.
`void`	`moveToLocalFile(Path src, Path dst)` The src file is under FS, and the dst is on the local disk.
`FSDataInputStream`	`open(Path f)` Opens an FSDataInputStream at the indicated Path.
`abstract FSDataInputStream`	`open(Path f, int bufferSize)` Opens an FSDataInputStream at the indicated Path.
`static void`	`printStatistics()`
`protected void`	`processDeleteOnExit()` Delete all files that were marked as delete-on-exit.
`abstract boolean`	`rename(Path src, Path dst)` Renames Path src to Path dst.
`static void`	`setDefaultUri(Configuration conf, String uri)` Set the default filesystem URI in a configuration.
`static void`	`setDefaultUri(Configuration conf, URI uri)` Set the default filesystem URI in a configuration.
`void`	`setOwner(Path p, String username, String groupname)` Set owner of a path (i.e. a file or a directory).
`void`	`setPermission(Path p, FsPermission permission)` Set permission of a path.
`boolean`	`setReplication(Path src, short replication)` Set replication for an existing file.
`void`	`setTimes(Path p, long mtime, long atime)` Set access time of a file
`void`	`setVerifyChecksum(boolean verifyChecksum)` Set the verify checksum flag.
`abstract void`	`setWorkingDirectory(Path new_dir)` Set the current working directory for the given file system.
`Path`	`startLocalOutput(Path fsOutputFile, Path tmpLocalFile)` Returns a local File that the user can write output to.

从类继承的方法 org.apache.hadoop.conf.Configured
getConf, setConf

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - FS_DEFAULT_NAME_KEY
```
public static final String FS_DEFAULT_NAME_KEY
```
    另请参阅:
    常量字段值
  - LOG
```
public static final org.apache.commons.logging.Log LOG
```
  - statistics
```
protected FileSystem.Statistics statistics
```
    The statistics for this file system.
- 构造器详细资料
  - FileSystem
```
protected FileSystem()
```
- 方法详细资料
  - addFileSystemForTesting
```
public static void addFileSystemForTesting(URI uri,
                           Configuration conf,
                           FileSystem fs)
                                    throws IOException
```
    This method adds a file system for testing so that we can find it later. It is only for testing.
    
    参数:
    uri - the uri to store it under
    conf - the configuration to store it under
    fs - the file system to store
    
    抛出:
    
    IOException
  - get
```
public static FileSystem get(URI uri,
             Configuration conf,
             String user)
                      throws IOException,
                             InterruptedException
```
    抛出:
    
    IOException
    
    InterruptedException
  - get
```
public static FileSystem get(Configuration conf)
                      throws IOException
```
    Returns the configured filesystem implementation.
    
    抛出:
    
    IOException
  - getDefaultUri
```
public static URI getDefaultUri(Configuration conf)
```
    Get the default filesystem URI from a configuration.
    
    参数:
    conf - the configuration to access
    
    返回:
    the uri of the default filesystem
  - setDefaultUri
```
public static void setDefaultUri(Configuration conf,
                 URI uri)
```
    Set the default filesystem URI in a configuration.
    
    参数:
    conf - the configuration to alter
    uri - the new default filesystem uri
  - setDefaultUri
```
public static void setDefaultUri(Configuration conf,
                 String uri)
```
    Set the default filesystem URI in a configuration.
    
    参数:
    conf - the configuration to alter
    uri - the new default filesystem uri
  - getCacheSize
```
@InterfaceAudience.Private
public static int getCacheSize()
```
    Get the number of entries in the filesystem cache
    
    返回:
    the number of entries in the filesystem cache
  - initialize
```
public void initialize(URI name,
              Configuration conf)
                throws IOException
```
    Called after a new FileSystem instance is constructed.
    
    参数:
    name - a uri whose authority section names the host, port, etc. for this FileSystem
    conf - the configuration
    
    抛出:
    
    IOException
  - getUri
```
public abstract URI getUri()
```
    Returns a URI whose scheme and authority identify this FileSystem.
  - getCanonicalUri
```
protected URI getCanonicalUri()
```
    Resolve the uri's hostname and add the default port if not in the uri
    
    返回:
    URI
    另请参阅:
    NetUtils.getCanonicalUri(URI, int)
  - getDefaultPort
```
protected int getDefaultPort()
```
    Get the default port for this file system.
    
    返回:
    the default port or 0 if there isn't one
  - getCanonicalServiceName
```
public String getCanonicalServiceName()
```
    Get a canonical service name for this file system. The token cache is the only user of this value, and uses it to lookup this filesystem's service tokens. The token cache will not attempt to acquire tokens if the service is null.
    
    返回:
    a service string that uniquely identifies this file system, null if the filesystem does not implement tokens
    另请参阅:
    SecurityUtil.buildDTServiceName(URI, int)
  - getName
```
public String getName()
```
    已过时。 call #getUri() instead.
  - getNamed
```
public static FileSystem getNamed(String name,
                  Configuration conf)
                           throws IOException
```
    已过时。 call #get(URI,Configuration) instead.
    
    抛出:
    
    IOException
  - getLocal
```
public static LocalFileSystem getLocal(Configuration conf)
                                throws IOException
```
    Get the local file syste
    
    参数:
    conf - the configuration to configure the file system with
    
    返回:
    a LocalFileSystem
    
    抛出:
    
    IOException
  - get
```
public static FileSystem get(URI uri,
             Configuration conf)
                      throws IOException
```
    Returns the FileSystem for this URI's scheme and authority. The scheme of the URI determines a configuration property name, fs.scheme.class whose value names the FileSystem class. The entire URI is passed to the FileSystem instance's initialize method.
    
    抛出:
    
    IOException
  - closeAll
```
public static void closeAll()
                     throws IOException
```
    Close all cached filesystems. Be sure those filesystems are not used anymore.
    
    抛出:
    
    IOException
  - closeAllForUGI
```
public static void closeAllForUGI(UserGroupInformation ugi)
                           throws IOException
```
    Close all cached filesystems for a given UGI. Be sure those filesystems are not used anymore.
    
    参数:
    ugi -
    
    抛出:
    
    IOException
  - makeQualified
```
public Path makeQualified(Path path)
```
    Make sure that a path specifies a FileSystem.
  - create
```
public static FSDataOutputStream create(FileSystem fs,
                        Path file,
                        FsPermission permission)
                                 throws IOException
```
    create a file with the provided permission The permission of the file is set to be the provided permission as in setPermission, not permission&~umask It is implemented using two RPCs. It is understood that it is inefficient, but the implementation is thread-safe. The other option is to change the value of umask in configuration to be 0, but it is not thread-safe.
    
    参数:
    fs - file system handle
    file - the name of the file to be created
    permission - the permission of the file
    
    返回:
    an output stream
    
    抛出:
    
    IOException
  - mkdirs
```
public static boolean mkdirs(FileSystem fs,
             Path dir,
             FsPermission permission)
                      throws IOException
```
    create a directory with the provided permission The permission of the directory is set to be the provided permission as in setPermission, not permission&~umask
    
    参数:
    fs - file system handle
    dir - the name of the directory to be created
    permission - the permission of the directory
    
    返回:
    true if the directory creation succeeds; false otherwise
    
    抛出:
    
    IOException
    另请参阅:
    create(FileSystem, Path, FsPermission)
  - checkPath
```
protected void checkPath(Path path)
```
    Check that a Path belongs to this FileSystem.
  - getFileBlockLocations
```
public BlockLocation[] getFileBlockLocations(FileStatus file,
                                    long start,
                                    long len)
                                      throws IOException
```
    Return an array containing hostnames, offset and size of portions of the given file. For a nonexistent file or regions, null will be returned. This call is most helpful with DFS, where it returns hostnames of machines that contain the given file. The FileSystem will simply return an elt containing 'localhost'.
    
    抛出:
    
    IOException
  - open
```
public abstract FSDataInputStream open(Path f,
                     int bufferSize)
                                throws IOException
```
    Opens an FSDataInputStream at the indicated Path.
    
    参数:
    f - the file name to open
    bufferSize - the size of the buffer to be used.
    
    抛出:
    
    IOException
  - open
```
public FSDataInputStream open(Path f)
                       throws IOException
```
    Opens an FSDataInputStream at the indicated Path.
    
    参数:
    f - the file to open
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path. Files are overwritten by default.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        boolean overwrite)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        Progressable progress)
                          throws IOException
```
    Create an FSDataOutputStream at the indicated Path with write-progress reporting. Files are overwritten by default.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        short replication)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path. Files are overwritten by default.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        short replication,
                        Progressable progress)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path with write-progress reporting. Files are overwritten by default.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        boolean overwrite,
                        int bufferSize)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path.
    
    参数:
    f - the file name to open
    overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    bufferSize - the size of the buffer to be used.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        boolean overwrite,
                        int bufferSize,
                        Progressable progress)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
    
    参数:
    f - the file name to open
    overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    bufferSize - the size of the buffer to be used.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        boolean overwrite,
                        int bufferSize,
                        short replication,
                        long blockSize)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path.
    
    参数:
    f - the file name to open
    overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    bufferSize - the size of the buffer to be used.
    replication - required block replication for the file.
    
    抛出:
    
    IOException
  - create
```
public FSDataOutputStream create(Path f,
                        boolean overwrite,
                        int bufferSize,
                        short replication,
                        long blockSize,
                        Progressable progress)
                          throws IOException
```
    Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
    
    参数:
    f - the file name to open
    overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    bufferSize - the size of the buffer to be used.
    replication - required block replication for the file.
    
    抛出:
    
    IOException
  - create
```
public abstract FSDataOutputStream create(Path f,
                        FsPermission permission,
                        boolean overwrite,
                        int bufferSize,
                        short replication,
                        long blockSize,
                        Progressable progress)
                                   throws IOException
```
    Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
    
    参数:
    f - the file name to open
    permission -
    overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    bufferSize - the size of the buffer to be used.
    replication - required block replication for the file.
    blockSize -
    progress -
    
    抛出:
    
    IOException
    另请参阅:
    setPermission(Path, FsPermission)
  - createNonRecursive
```
@Deprecated
public FSDataOutputStream createNonRecursive(Path f,
                                               boolean overwrite,
                                               int bufferSize,
                                               short replication,
                                               long blockSize,
                                               Progressable progress)
                                      throws IOException
```
    已过时。 API only for 0.20-append
    
    Opens an FSDataOutputStream at the indicated Path with write-progress reporting. Same as create(), except fails if parent directory doesn't already exist.
    
    参数:
    f - the file name to open
    overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    bufferSize - the size of the buffer to be used.
    replication - required block replication for the file.
    blockSize -
    progress -
    
    抛出:
    
    IOException
    另请参阅:
    setPermission(Path, FsPermission)
  - createNonRecursive
```
@Deprecated
public FSDataOutputStream createNonRecursive(Path f,
                                               FsPermission permission,
                                               boolean overwrite,
                                               int bufferSize,
                                               short replication,
                                               long blockSize,
                                               Progressable progress)
                                      throws IOException
```
    已过时。 API only for 0.20-append
    
    Opens an FSDataOutputStream at the indicated Path with write-progress reporting. Same as create(), except fails if parent directory doesn't already exist.
    
    参数:
    f - the file name to open
    permission -
    overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    bufferSize - the size of the buffer to be used.
    replication - required block replication for the file.
    blockSize -
    progress -
    
    抛出:
    
    IOException
    另请参阅:
    setPermission(Path, FsPermission)
  - createNewFile
```
public boolean createNewFile(Path f)
                      throws IOException
```
    Creates the given Path as a brand-new zero-length file. If create fails, or if it already existed, return false.
    
    抛出:
    
    IOException
  - append
```
public FSDataOutputStream append(Path f)
                          throws IOException
```
    Append to an existing file (optional operation). Same as append(f, getConf().getInt("io.file.buffer.size", 4096), null)
    
    参数:
    f - the existing file to be appended.
    
    抛出:
    
    IOException
  - append
```
public FSDataOutputStream append(Path f,
                        int bufferSize)
                          throws IOException
```
    Append to an existing file (optional operation). Same as append(f, bufferSize, null).
    
    参数:
    f - the existing file to be appended.
    bufferSize - the size of the buffer to be used.
    
    抛出:
    
    IOException
  - append
```
public abstract FSDataOutputStream append(Path f,
                        int bufferSize,
                        Progressable progress)
                                   throws IOException
```
    Append to an existing file (optional operation).
    
    参数:
    f - the existing file to be appended.
    bufferSize - the size of the buffer to be used.
    progress - for reporting progress if it is not null.
    
    抛出:
    
    IOException
  - concat
```
public void concat(Path trg,
          Path[] srcs)
            throws IOException
```
    Concat existing files together.
    
    参数:
    trg - the path to the target destination.
    psrcs - the paths to the sources to use for the concatenation.
    
    抛出:
    
    IOException
  - getReplication
```
@Deprecated
public short getReplication(Path src)
                     throws IOException
```
    已过时。 Use getFileStatus() instead
    
    Get replication.
    
    参数:
    src - file name
    
    返回:
    file replication
    
    抛出:
    
    IOException
  - setReplication
```
public boolean setReplication(Path src,
                     short replication)
                       throws IOException
```
    Set replication for an existing file.
    
    参数:
    src - file name
    replication - new replication
    
    返回:
    true if successful; false if file does not exist or is a directory
    
    抛出:
    
    IOException
  - rename
```
public abstract boolean rename(Path src,
             Path dst)
                        throws IOException
```
    Renames Path src to Path dst. Can take place on local fs or remote DFS.
    
    抛出:
    
    IOException
  - delete
```
@Deprecated
public abstract boolean delete(Path f)
                        throws IOException
```
    已过时。 Use delete(Path, boolean) instead
    
    抛出:
    
    IOException
  - delete
```
public abstract boolean delete(Path f,
             boolean recursive)
                        throws IOException
```
    Delete a file.
    
    参数:
    f - the path to delete.
    recursive - if path is a directory and set to true, the directory is deleted else throws an exception. In case of a file the recursive can be set to either true or false.
    
    返回:
    true if delete is successful else false.
    
    抛出:
    
    IOException
  - deleteOnExit
```
public boolean deleteOnExit(Path f)
                     throws IOException
```
    Mark a path to be deleted when FileSystem is closed. When the JVM shuts down, all FileSystem objects will be closed automatically. Then, the marked path will be deleted as a result of closing the FileSystem. The path has to exist in the file system.
    
    参数:
    f - the path to delete.
    
    返回:
    true if deleteOnExit is successful, otherwise false.
    
    抛出:
    
    IOException
  - processDeleteOnExit
```
protected void processDeleteOnExit()
```
    Delete all files that were marked as delete-on-exit. This recursively deletes all files in the specified paths.
  - exists
```
public boolean exists(Path f)
               throws IOException
```
    Check if exists.
    
    参数:
    f - source file
    
    抛出:
    
    IOException
  - isDirectory
```
@Deprecated
public boolean isDirectory(Path f)
                    throws IOException
```
    已过时。 Use getFileStatus() instead
    
    抛出:
    
    IOException
  - isFile
```
public boolean isFile(Path f)
               throws IOException
```
    True iff the named path is a regular file.
    
    抛出:
    
    IOException
  - getLength
```
@Deprecated
public long getLength(Path f)
               throws IOException
```
    已过时。 Use getFileStatus() instead
    
    抛出:
    
    IOException
  - getContentSummary
```
public ContentSummary getContentSummary(Path f)
                                 throws IOException
```
    Return the ContentSummary of a given Path.
    
    抛出:
    
    IOException
  - listStatus
```
public abstract FileStatus[] listStatus(Path f)
                                 throws IOException
```
    List the statuses of the files/directories in the given path if the path is a directory.
    
    参数:
    f - given path
    
    返回:
    the statuses of the files/directories in the given patch returns null, if Path f does not exist in the FileSystem
    
    抛出:
    
    IOException
  - listStatus
```
public FileStatus[] listStatus(Path f,
                      PathFilter filter)
                        throws IOException
```
    Filter files/directories in the given path using the user-supplied path filter.
    
    参数:
    f - a path name
    filter - the user-supplied path filter
    
    返回:
    an array of FileStatus objects for the files under the given path after applying the filter
    
    抛出:
    
    IOException - if encounter any problem while fetching the status
  - listStatus
```
public FileStatus[] listStatus(Path[] files)
                        throws IOException
```
    Filter files/directories in the given list of paths using default path filter.
    
    参数:
    files - a list of paths
    
    返回:
    a list of statuses for the files under the given paths after applying the filter default Path filter
    
    抛出:
    
    IOException
  - listStatus
```
public FileStatus[] listStatus(Path[] files,
                      PathFilter filter)
                        throws IOException
```
    Filter files/directories in the given list of paths using user-supplied path filter.
    
    参数:
    files - a list of paths
    filter - the user-supplied path filter
    
    返回:
    a list of statuses for the files under the given paths after applying the filter
    
    抛出:
    
    IOException
  - globStatus
```
public FileStatus[] globStatus(Path pathPattern)
                        throws IOException
```
    Return all the files that match filePattern and are not checksum files. Results are sorted by their names.
    A filename pattern is composed of regular characters and special pattern matching characters, which are:
    
    ?
    Matches any single character.
    
    *
    Matches zero or more characters.
    
    [abc]
    Matches a single character from character set {a,b,c}.
    
    [a-b]
    Matches a single character from the character range {a...b}. Note that character a must be lexicographically less than or equal to character b.
    
    [^a]
    Matches a single character that is not from character set or range {a}. Note that the ^ character must occur immediately to the right of the opening bracket.
    
    \c
    Removes (escapes) any special meaning of character c.
    
    {ab,cd}
    Matches a string from the string set {ab, cd}
    
    {ab,c{de,fh}}
    Matches a string from the string set {ab, cde, cfh}
    
    参数:
    pathPattern - a regular expression specifying a pth pattern
    
    返回:
    an array of paths that match the path pattern
    
    抛出:
    
    IOException
  - globStatus
```
public FileStatus[] globStatus(Path pathPattern,
                      PathFilter filter)
                        throws IOException
```
    Return an array of FileStatus objects whose path names match pathPattern and is accepted by the user-supplied path filter. Results are sorted by their path names. Return null if pathPattern has no glob and the path does not exist. Return an empty array if pathPattern has a glob and no path matches it.
    
    参数:
    pathPattern - a regular expression specifying the path pattern
    filter - a user-supplied path filter
    
    返回:
    an array of FileStatus objects
    
    抛出:
    
    IOException - if any I/O error occurs when fetching file status
  - getHomeDirectory
```
public Path getHomeDirectory()
```
    Return the current user's home directory in this filesystem. The default implementation returns "/user/$USER/".
  - getDelegationToken
```
public Token<?> getDelegationToken(String renewer)
                            throws IOException
```
    Get a new delegation token for this file system.
    
    参数:
    renewer - the account name that is allowed to renew the token.
    
    返回:
    a new delegation token
    
    抛出:
    
    IOException
  - setWorkingDirectory
```
public abstract void setWorkingDirectory(Path new_dir)
```
    Set the current working directory for the given file system. All relative paths will be resolved relative to it.
    
    参数:
    new_dir -
  - getWorkingDirectory
```
public abstract Path getWorkingDirectory()
```
    Get the current working directory for the given file system
    
    返回:
    the directory pathname
  - mkdirs
```
public boolean mkdirs(Path f)
               throws IOException
```
    Call mkdirs(Path, FsPermission) with default permission.
    
    抛出:
    
    IOException
  - mkdirs
```
public abstract boolean mkdirs(Path f,
             FsPermission permission)
                        throws IOException
```
    Make the given file and all non-existent parents into directories. Has the semantics of Unix 'mkdir -p'. Existence of the directory hierarchy is not an error.
    
    抛出:
    
    IOException
  - copyFromLocalFile
```
public void copyFromLocalFile(Path src,
                     Path dst)
                       throws IOException
```
    The src file is on the local disk. Add it to FS at the given dst name and the source is kept intact afterwards
    
    抛出:
    
    IOException
  - moveFromLocalFile
```
public void moveFromLocalFile(Path[] srcs,
                     Path dst)
                       throws IOException
```
    The src files is on the local disk. Add it to FS at the given dst name, removing the source afterwards.
    
    抛出:
    
    IOException
  - moveFromLocalFile
```
public void moveFromLocalFile(Path src,
                     Path dst)
                       throws IOException
```
    The src file is on the local disk. Add it to FS at the given dst name, removing the source afterwards.
    
    抛出:
    
    IOException
  - copyFromLocalFile
```
public void copyFromLocalFile(boolean delSrc,
                     Path src,
                     Path dst)
                       throws IOException
```
    The src file is on the local disk. Add it to FS at the given dst name. delSrc indicates if the source should be removed
    
    抛出:
    
    IOException
  - copyFromLocalFile
```
public void copyFromLocalFile(boolean delSrc,
                     boolean overwrite,
                     Path[] srcs,
                     Path dst)
                       throws IOException
```
    The src files are on the local disk. Add it to FS at the given dst name. delSrc indicates if the source should be removed
    
    抛出:
    
    IOException
  - copyFromLocalFile
```
public void copyFromLocalFile(boolean delSrc,
                     boolean overwrite,
                     Path src,
                     Path dst)
                       throws IOException
```
    The src file is on the local disk. Add it to FS at the given dst name. delSrc indicates if the source should be removed
    
    抛出:
    
    IOException
  - copyToLocalFile
```
public void copyToLocalFile(Path src,
                   Path dst)
                     throws IOException
```
    The src file is under FS, and the dst is on the local disk. Copy it from FS control to the local dst name.
    
    抛出:
    
    IOException
  - moveToLocalFile
```
public void moveToLocalFile(Path src,
                   Path dst)
                     throws IOException
```
    The src file is under FS, and the dst is on the local disk. Copy it from FS control to the local dst name. Remove the source afterwards
    
    抛出:
    
    IOException
  - copyToLocalFile
```
public void copyToLocalFile(boolean delSrc,
                   Path src,
                   Path dst)
                     throws IOException
```
    The src file is under FS, and the dst is on the local disk. Copy it from FS control to the local dst name. delSrc indicates if the src will be removed or not.
    
    抛出:
    
    IOException
  - startLocalOutput
```
public Path startLocalOutput(Path fsOutputFile,
                    Path tmpLocalFile)
                      throws IOException
```
    Returns a local File that the user can write output to. The caller provides both the eventual FS target name and the local working file. If the FS is local, we write directly into the target. If the FS is remote, we write into the tmp local area.
    
    抛出:
    
    IOException
  - completeLocalOutput
```
public void completeLocalOutput(Path fsOutputFile,
                       Path tmpLocalFile)
                         throws IOException
```
    Called when we're all done writing to the target. A local FS will do nothing, because we've written to exactly the right place. A remote FS will copy the contents of tmpLocalFile to the correct target at fsOutputFile.
    
    抛出:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    No more filesystem operations are needed. Will release any held locks.
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException
  - getUsed
```
public long getUsed()
             throws IOException
```
    Return the total size of all files in the filesystem.
    
    抛出:
    
    IOException
  - getBlockSize
```
@Deprecated
public long getBlockSize(Path f)
                  throws IOException
```
    已过时。 Use getFileStatus() instead
    
    抛出:
    
    IOException
  - getDefaultBlockSize
```
@Deprecated
public long getDefaultBlockSize()
```
    已过时。 use getDefaultBlockSize(Path) instead
    
    Return the number of bytes that large input files should be optimally be split into to minimize i/o time.
  - getDefaultBlockSize
```
public long getDefaultBlockSize(Path f)
```
    Return the number of bytes that large input files should be optimally be split into to minimize i/o time.
    
    参数:
    f - path of file
    
    返回:
    the default block size for the path's filesystem
  - getDefaultReplication
```
@Deprecated
public short getDefaultReplication()
```
    已过时。 use getDefaultReplication(Path) instead
    
    Get the default replication.
  - getDefaultReplication
```
public short getDefaultReplication(Path path)
```
    Get the default replication.
    
    参数:
    path - of the file
    
    返回:
    default replication for the path's filesystem
  - getFileStatus
```
public abstract FileStatus getFileStatus(Path f)
                                  throws IOException
```
    Return a file status object that represents the path.
    
    参数:
    f - The path we want information from
    
    返回:
    a FileStatus object
    
    抛出:
    
    FileNotFoundException - when the path does not exist; IOException see specific implementation
    
    IOException
  - getFileChecksum
```
public FileChecksum getFileChecksum(Path f)
                             throws IOException
```
    Get the checksum of a file.
    
    参数:
    f - The file path
    
    返回:
    The file checksum. The default return value is null, which indicates that no checksum algorithm is implemented in the corresponding FileSystem.
    
    抛出:
    
    IOException
  - setVerifyChecksum
```
public void setVerifyChecksum(boolean verifyChecksum)
```
    Set the verify checksum flag. This is only applicable if the corresponding FileSystem supports checksum. By default doesn't do anything.
    
    参数:
    verifyChecksum -
  - setPermission
```
public void setPermission(Path p,
                 FsPermission permission)
                   throws IOException
```
    Set permission of a path.
    
    参数:
    p -
    permission -
    
    抛出:
    
    IOException
  - setOwner
```
public void setOwner(Path p,
            String username,
            String groupname)
              throws IOException
```
    Set owner of a path (i.e. a file or a directory). The parameters username and groupname cannot both be null.
    
    参数:
    p - The path
    username - If it is null, the original username remains unchanged.
    groupname - If it is null, the original groupname remains unchanged.
    
    抛出:
    
    IOException
  - setTimes
```
public void setTimes(Path p,
            long mtime,
            long atime)
              throws IOException
```
    Set access time of a file
    
    参数:
    p - The path
    mtime - Set the modification time of this file. The number of milliseconds since Jan 1, 1970. A value of -1 means that this call should not set modification time.
    atime - Set the access time of this file. The number of milliseconds since Jan 1, 1970. A value of -1 means that this call should not set access time.
    
    抛出:
    
    IOException
  - getStatistics
```
public static Map<String,FileSystem.Statistics> getStatistics()
```
    已过时。 use getAllStatistics() instead
    
    Get the Map of Statistics object indexed by URI Scheme.
    
    返回:
    a Map having a key as URI scheme and value as Statistics object
  - getAllStatistics
```
public static List<FileSystem.Statistics> getAllStatistics()
```
    Return the FileSystem classes that have Statistics
  - getStatistics
```
public static FileSystem.Statistics getStatistics(String scheme,
                                  Class<? extends FileSystem> cls)
```
    Get the statistics for a particular file system
    
    参数:
    cls - the class to lookup
    
    返回:
    a statistics object
  - clearStatistics
```
public static void clearStatistics()
```
  - printStatistics
```
public static void printStatistics()
                            throws IOException
```
    抛出:
    
    IOException

类 FileSystem

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 org.apache.hadoop.conf.Configured

从类继承的方法 java.lang.Object

字段详细资料

FS_DEFAULT_NAME_KEY

LOG

statistics

构造器详细资料

FileSystem

方法详细资料

addFileSystemForTesting

get

get

getDefaultUri

setDefaultUri

setDefaultUri

getCacheSize

initialize

getUri

getCanonicalUri

getDefaultPort

getCanonicalServiceName

getName

getNamed

getLocal

get

closeAll

closeAllForUGI

makeQualified

create

mkdirs

checkPath

getFileBlockLocations

open

open

create

create

create

create

create

create

create

create

create

create

createNonRecursive

createNonRecursive

createNewFile

append

append

append

concat

getReplication

setReplication

rename

delete

delete

deleteOnExit

processDeleteOnExit

exists

isDirectory

isFile

getLength

getContentSummary

listStatus

listStatus

listStatus

listStatus

globStatus

globStatus

getHomeDirectory

getDelegationToken

setWorkingDirectory

getWorkingDirectory

mkdirs

mkdirs