org.apache.hadoop.fs.impl (Apache Hadoop Common 3.5.0 API)
Description: declaration: package: org.apache.hadoop.fs.impl

# Package org.apache.hadoop.fs.impl

@LimitedPrivate("Filesystems") @Unstable package org.apache.hadoop.fs.impl
This package contains implementation classes for use inside filesystems. These classes MUST NOT be directly exposed as the arguments or return values of methods, or as part of a visible inheritance tree. These classes MAY be returned behind interfaces. When such interfaces are used as parameters, the methods which accept the interfaces MUST NOT cast them to the classes contained therein: they MUST interact purely through the interface. That is: don't expose the implementation classes in here, and don't expect input interface implementations to always be the classes in here. These classes are for the private use of FileSystem/ FileContext implementations. Implementation classes not developed within the ASF Hadoop codebase MAY use these, with the caveat that these classes are highly unstable.

- Related Packages
  Package
  Description
  org.apache.hadoop.fs
  An abstract file system API.
  org.apache.hadoop.fs.impl.prefetch
  block caching for use in object store clients.
- Class
  Description
  AbstractFSBuilderImpl<S,B extends FSBuilder<S,B>>
  Builder for filesystem/filecontext operations of various kinds, with option support.
  AbstractMultipartUploader
  Standard base class for Multipart Uploaders.
  BackReference
  Holds reference to an object to be attached to a stream or store to avoid the reference being lost to GC.
  CombinedFileRange
  A file range that represents a set of underlying file ranges.
  DefaultBulkDeleteOperation
  Default implementation of the `BulkDelete` interface.
  FileRangeImpl
  A range of bytes from a file with an optional buffer to read those bytes for zero copy.
  FileSystemMultipartUploader
  A MultipartUploader that uses the basic FileSystem commands.
  FileSystemMultipartUploaderBuilder
  Builder for `FileSystemMultipartUploader`.
  FlagSet<E extends Enum<E>>
  A set of flags, constructed from a configuration option or from a string, with the semantics of `ConfigurationHelper.parseEnumSet(String, String, Class, boolean)` and implementing `StreamCapabilities`.
  FSBuilderSupport
  Class to help with use of FSBuilder.
  FsLinkResolution<T>
  Class to allow Lambda expressions to be used in `FileContext` link resolution.
  FsLinkResolution.FsLinkResolutionFunction<T>
  The signature of the function to invoke.
  FunctionsRaisingIOE
  Deprecated.
  use `org.apache.hadoop.util.functional`
  FunctionsRaisingIOE.BiFunctionRaisingIOE<T,U,R>
  Deprecated.
  use `BiFunctionRaisingIOE`
  FunctionsRaisingIOE.CallableRaisingIOE<R>
  Deprecated.
  use `CallableRaisingIOE`
  FunctionsRaisingIOE.FunctionRaisingIOE<T,R>
  Deprecated.
  use `FunctionRaisingIOE`
  FutureDataInputStreamBuilderImpl
  Builder for input streams and subclasses whose return value is actually a completable future: this allows for better asynchronous operation.
  FutureIOSupport
  Deprecated.
  LeakReporter
  A class to report leaks of streams.
  MultipartUploaderBuilderImpl<S extends MultipartUploader,B extends MultipartUploaderBuilder<S,B>>
  Builder for `MultipartUploader` implementations.
  OpenFileParameters
  All the parameters from the openFile builder for the `openFileWithOptions` commands.
  PathCapabilitiesSupport
  StoreImplementationUtils
  Utility classes to help implementing filesystems and streams.
  TrackingByteBufferPool
  A wrapper `ByteBufferPool` implementation that tracks whether all allocated buffers are released.
  TrackingByteBufferPool.ByteBufferAllocationStacktraceException
  Strack trace of allocation as saved in the tracking map.
  TrackingByteBufferPool.LeakDetectorHeapByteBufferPoolException
  TrackingByteBufferPool.LeakedByteBufferException
  Exception raised in `TrackingByteBufferPool.close()` if there was an unreleased buffer.
  TrackingByteBufferPool.ReleasingUnallocatedByteBufferException
  Exception raised in `TrackingByteBufferPool.putBuffer(ByteBuffer)` if the buffer to release was not in the hash map.
  VectorIOBufferPool
  A ByteBufferPool implementation that uses a pair of functions to allocate and release ByteBuffers; intended for use implementing the VectorIO API as it makes the pair of functions easier to pass around and use in existing code.
  WeakReferenceThreadMap<V>
  A WeakReferenceMap for threads.
  WeakRefMetricsSource
  A weak referenced metrics source which avoids hanging on to large objects if somehow they don't get fully closed/cleaned up.
  WrappedIOException
  Deprecated.
  use the `UncheckedIOException` directly.]