# Uses of Package
org.apache.hadoop.fs

- Packages that use org.apache.hadoop.fs
  Package | Description
  --- | ---
  org.apache.hadoop.conf | Configuration of system parameters.
  org.apache.hadoop.fs | An abstract file system API.
  org.apache.hadoop.fs.crypto |
  org.apache.hadoop.fs.ftp |
  org.apache.hadoop.fs.http | Filesystem implementations that allow Hadoop to read directly from HTTP / HTTPS endpoints.
  org.apache.hadoop.fs.impl | This package contains implementation classes for use inside filesystems.
  org.apache.hadoop.fs.protocolPB | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.fs.sftp | SFTP FileSystem package.
  org.apache.hadoop.fs.shell.find |
  org.apache.hadoop.fs.store | This package is for classes to be shared across object stores; for internal use within the hadoop-* modules only.
  org.apache.hadoop.fs.viewfs | ViewFileSystem and ViewFileSystemOverloadScheme classes.
  org.apache.hadoop.io | Generic i/o code for use when reading and writing data to the network, to databases, and to files.
  org.apache.hadoop.io.compress |
  org.apache.hadoop.io.file.tfile |
  org.apache.hadoop.metrics2.sink | Builtin metrics sinks
  org.apache.hadoop.security |
  org.apache.hadoop.util | Common utilities.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.conf
  Class and Description
  Path Names a file or directory in a `FileSystem`.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs
  Class and Description
  AbstractFileSystem This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
  BatchedRemoteIterator.BatchedEntries
  BlockLocation Represents the network location of a block, information about the hosts that contain block replicas, and other block metadata (E.g.
  BlockStoragePolicySpi A storage policy specifies the placement of block replicas on specific storage types.
  ByteBufferReadable Implementers of this interface provide a read API that writes to a ByteBuffer, not a byte[].
  CanSetDropBehind
  CanSetReadahead
  CanUnbuffer FSDataInputStreams implement this interface to indicate that they can clear their buffers on request.
  ChecksumFileSystem Abstract Checksumed FileSystem.
  ContentSummary Store the summary of a content (a directory or a file).
  ContentSummary.Builder We don't use generics.
  CreateFlag CreateFlag specifies the file create semantic.
  DelegationTokenRenewer.Renewable The renewable interface used by the renewer.
  FileAlreadyExistsException Used when target file already exists for any operation and is not configured to be overwritten.
  FileChecksum An abstract class representing file checksums for files.
  FileContext The FileContext class provides an interface for users of the Hadoop file system.
  FileContext.Util Utility/library methods built over the basic FileContext methods.
  FileStatus Interface that represents the client side information for a file.
  FileStatus.AttrFlags Flags for entity attributes.
  FileSystem An abstract base class for a fairly generic filesystem.
  FileSystem.Statistics Tracks statistics about how many reads, writes, and so forth have been done in a FileSystem.
  FileSystem.Statistics.StatisticsData Statistics data.
  FilterFileSystem A `FilterFileSystem` contains some other file system, which it uses as its basic file system, possibly transforming the data along the way or providing additional functionality.
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.
  FSDataOutputStreamBuilder Builder for `FSDataOutputStream` and its subclasses.
  FSProtos.FileStatusProto Protobuf type `hadoop.fs.FileStatusProto`
  FSProtos.FileStatusProto.Builder Protobuf type `hadoop.fs.FileStatusProto`
  FSProtos.FileStatusProto.FileType Protobuf enum `hadoop.fs.FileStatusProto.FileType`
  FSProtos.FileStatusProto.Flags Protobuf enum `hadoop.fs.FileStatusProto.Flags`
  FSProtos.FileStatusProtoOrBuilder
  FSProtos.FsPermissionProto Protobuf type `hadoop.fs.FsPermissionProto`
  FSProtos.FsPermissionProto.Builder Protobuf type `hadoop.fs.FsPermissionProto`
  FSProtos.FsPermissionProtoOrBuilder
  FSProtos.LocalFileSystemPathHandleProto Protobuf type `hadoop.fs.LocalFileSystemPathHandleProto`
  FSProtos.LocalFileSystemPathHandleProto.Builder Protobuf type `hadoop.fs.LocalFileSystemPathHandleProto`
  FSProtos.LocalFileSystemPathHandleProtoOrBuilder
  FsServerDefaults Provides server default configuration values to clients.
  FsShellPermissions.Chown Used to change owner and/or group of files
  FsStatus This class is used to represent the capacity, free and used space on a `FileSystem`.
  GetSpaceUsed
  GetSpaceUsed.Builder The builder class
  GlobalStorageStatistics Stores global storage statistics objects.
  GlobalStorageStatistics.StorageStatisticsProvider A callback API for creating new StorageStatistics instances.
  HardLink Class for creating hardlinks.
  HardLink.LinkStats HardLink statistics counters and methods.
  InvalidPathHandleException Thrown when the constraints enoded in a `PathHandle` do not hold.
  LocalFileSystem Implement the FileSystem API for the checksumed local filesystem.
  LocatedFileStatus This class defines a FileStatus that includes a file's block locations.
  Options.ChecksumCombineMode Enum for indicating what mode to use when combining chunk and block checksums to define an aggregate FileChecksum.
  Options.ChecksumOpt This is used in FileSystem and FileContext to specify checksum options.
  Options.CreateOpts Class to support the varargs for create() options.
  Options.CreateOpts.BlockSize
  Options.CreateOpts.BufferSize
  Options.CreateOpts.BytesPerChecksum This is not needed if ChecksumParam is specified.
  Options.CreateOpts.ChecksumParam
  Options.CreateOpts.CreateParent
  Options.CreateOpts.Perms
  Options.CreateOpts.Progress
  Options.CreateOpts.ReplicationFactor
  Options.HandleOpt Options for creating `PathHandle` references.
  Options.HandleOpt.Data Option storing standard constraints on data.
  Options.HandleOpt.Location Option storing standard constraints on location.
  Options.Rename Enum to support the varargs for rename() options
  ParentNotDirectoryException Indicates that the parent of specified Path is not a directory as expected.
  Path Names a file or directory in a `FileSystem`.
  PathCapabilities The Path counterpoint to `StreamCapabilities`; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.
  PathExistsException Exception corresponding to File Exists - EEXISTS
  PathFilter
  PathHandle Opaque, serializable reference to an entity in the FileSystem.
  PathIOException Exceptions based on standard posix/linux style exceptions for path related errors.
  PositionedReadable Stream that permits positional reading.
  QuotaUsage Store the quota usage of a directory.
  QuotaUsage.Builder Builder class for QuotaUsage.
  ReadOption Options that can be used when reading from a FileSystem.
  RemoteIterator An iterator over a collection whose elements need to be fetched remotely
  Seekable Stream that permits seeking.
  StorageStatistics StorageStatistics contains statistics data for a FileSystem or FileContext instance.
  StorageStatistics.LongStatistic A 64-bit storage statistic.
  StorageType Defines the types of supported storage media.
  StreamCapabilities Interface to query streams for supported capabilities.
  StreamCapabilities.StreamCapability Deprecated.
  Syncable This interface for flush/sync operation.
  TrashPolicy This interface is used for implementing different Trash policies.
  UnsupportedFileSystemException File system for a given file system name/scheme is not supported
  XAttrCodec The value of `XAttr` is byte[], this class is to covert byte[] to some kind of string representation or convert back.
  XAttrSetFlag

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.crypto
  Class and Description
  ByteBufferReadable Implementers of this interface provide a read API that writes to a ByteBuffer, not a byte[].
  CanSetDropBehind
  CanSetReadahead
  CanUnbuffer FSDataInputStreams implement this interface to indicate that they can clear their buffers on request.
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.
  PositionedReadable Stream that permits positional reading.
  Seekable Stream that permits seeking.
  StreamCapabilities Interface to query streams for supported capabilities.
  Syncable This interface for flush/sync operation.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.ftp
  Class and Description
  FileStatus Interface that represents the client side information for a file.
  FileSystem An abstract base class for a fairly generic filesystem.
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.
  Path Names a file or directory in a `FileSystem`.
  PathCapabilities The Path counterpoint to `StreamCapabilities`; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.http
  Class and Description
  FileSystem An abstract base class for a fairly generic filesystem.
  PathCapabilities The Path counterpoint to `StreamCapabilities`; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.impl
  Class and Description
  AbstractFileSystem This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
  Path Names a file or directory in a `FileSystem`.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.protocolPB
  Class and Description
  FileStatus Interface that represents the client side information for a file.
  FSProtos.FileStatusProto Protobuf type `hadoop.fs.FileStatusProto`
  FSProtos.FsPermissionProto Protobuf type `hadoop.fs.FsPermissionProto`

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.sftp
  Class and Description
  FileStatus Interface that represents the client side information for a file.
  FileSystem An abstract base class for a fairly generic filesystem.
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.
  Path Names a file or directory in a `FileSystem`.
  PathCapabilities The Path counterpoint to `StreamCapabilities`; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.shell.find
  Class and Description
  FileStatus Interface that represents the client side information for a file.
  FileSystem An abstract base class for a fairly generic filesystem.
  Path Names a file or directory in a `FileSystem`.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.store
  Class and Description
  FileChecksum An abstract class representing file checksums for files.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.viewfs
  Class and Description
  AbstractFileSystem This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
  BlockLocation Represents the network location of a block, information about the hosts that contain block replicas, and other block metadata (E.g.
  BlockStoragePolicySpi A storage policy specifies the placement of block replicas on specific storage types.
  ContentSummary Store the summary of a content (a directory or a file).
  CreateFlag CreateFlag specifies the file create semantic.
  FileAlreadyExistsException Used when target file already exists for any operation and is not configured to be overwritten.
  FileChecksum An abstract class representing file checksums for files.
  FileStatus Interface that represents the client side information for a file.
  FileSystem An abstract base class for a fairly generic filesystem.
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.
  FsServerDefaults Provides server default configuration values to clients.
  FsStatus This class is used to represent the capacity, free and used space on a `FileSystem`.
  LocatedFileStatus This class defines a FileStatus that includes a file's block locations.
  Options.ChecksumOpt This is used in FileSystem and FileContext to specify checksum options.
  ParentNotDirectoryException Indicates that the parent of specified Path is not a directory as expected.
  Path Names a file or directory in a `FileSystem`.
  PathCapabilities The Path counterpoint to `StreamCapabilities`; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.
  PathFilter
  QuotaUsage Store the quota usage of a directory.
  RemoteIterator An iterator over a collection whose elements need to be fetched remotely
  UnsupportedFileSystemException File system for a given file system name/scheme is not supported
  XAttrSetFlag

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.io
  Class and Description
  CreateFlag CreateFlag specifies the file create semantic.
  FileContext The FileContext class provides an interface for users of the Hadoop file system.
  FileSystem An abstract base class for a fairly generic filesystem.
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.
  Options.CreateOpts Class to support the varargs for create() options.
  Path Names a file or directory in a `FileSystem`.
  Syncable This interface for flush/sync operation.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.io.compress
  Class and Description
  Path Names a file or directory in a `FileSystem`.
  Seekable Stream that permits seeking.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.io.file.tfile
  Class and Description
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.metrics2.sink
  Class and Description
  FileSystem An abstract base class for a fairly generic filesystem.
  Path Names a file or directory in a `FileSystem`.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.security
  Class and Description
  FileSystem An abstract base class for a fairly generic filesystem.
  Path Names a file or directory in a `FileSystem`.

- Classes in org.apache.hadoop.fs used by org.apache.hadoop.util
  Class and Description
  FSDataInputStream Utility that wraps a `FSInputStream` in a `DataInputStream` and buffers input through a `BufferedInputStream`.
  FSDataOutputStream Utility that wraps a `OutputStream` in a `DataOutputStream`.
  Path Names a file or directory in a `FileSystem`.

Copyright © 2008–2022 Apache Software Foundation. All rights reserved.