@CheckReturnValue @ParametersAreNonnullByDefault
Package com.google.common.jimfs
Package containing the Jimfs file system API and implementation. Most users should only need to
use the
Jimfs
and Configuration
classes.-
Interface Summary Interface Description FileLookup Callback for looking up a file.FileTimeSource A source of the current time as aFileTime
, to enable fake time sources for testing.UnixFileAttributeView Dummy view interface for the "unix" view, which doesn't have a public view interface. -
Class Summary Class Description AbstractAttributeView Abstract base class forFileAttributeView
implementations.AbstractWatchService Abstract implementation ofWatchService
.AbstractWatchService.Event<T> A basic implementation ofWatchEvent
.AbstractWatchService.Key Implementation ofWatchKey
for anAbstractWatchService
.AclAttributeProvider Attribute provider that provides theAclFileAttributeView
("acl").AclAttributeProvider.View Implementation ofAclFileAttributeView
.AttributeProvider Abstract provider for handling a specific file attribute view.AttributeService Service providing all attribute related operations for a file store.AttributeService.SimpleFileAttribute<T> Simple implementation ofFileAttribute
.BasicAttributeProvider Attribute provider that provides attributes common to all file systems, theBasicFileAttributeView
("basic" or no view prefix), and allows the reading ofBasicFileAttributes
.BasicAttributeProvider.Attributes Implementation ofBasicFileAttributes
.BasicAttributeProvider.View Implementation ofBasicFileAttributeView
.Configuration Immutable configuration for an in-memory file system.Configuration.Builder Mutable builder forConfiguration
objects.Configuration.OsxHolder Configuration.UnixHolder Configuration.WindowsHolder Directory A table of directory entries.DirectoryEntry Entry in a directory, containing references to the directory itself, the file the entry links to and the name of the entry.DosAttributeProvider Attribute provider that provides theDosFileAttributeView
("dos") and allows the reading ofDosFileAttributes
.DosAttributeProvider.Attributes Implementation ofDosFileAttributes
.DosAttributeProvider.View Implementation ofDosFileAttributeView
.DowngradedDirectoryStream A thin wrapper around aSecureDirectoryStream
that exists only to implementDirectoryStream
and NOT implementSecureDirectoryStream
.DowngradedSeekableByteChannel A thin wrapper around aFileChannel
that exists only to implementSeekableByteChannel
but NOT extendFileChannel
.File A file object, containing both the file's metadata and content.FileFactory Factory for creating new files and copying files.FileSystemState Object that manages the open/closed state of a file system, ensuring that all open resources are closed when the file system is closed and that file system methods throw an exception when the file system has been closed.FileSystemView View of a file system with a specific working directory.FileTree The tree of directories and files for the file system.GlobToRegex Translates globs to regex patterns.GlobToRegex.State Converter state.Handler URLStreamHandler
implementation for jimfs.HeapDisk A resizable pseudo-disk acting as a shared space for storing file data.InternalCharMatcher Simple replacement for the real CharMatcher until it's out of @Beta.Java8Compatibility Wrappers aroundBuffer
methods that are covariantly overridden in Java 9+.Jimfs Static factory methods for creating new Jimfs file systems.JimfsAsynchronousFileChannel AsynchronousFileChannel
implementation that delegates to aJimfsFileChannel
.JimfsAsynchronousFileChannel.CompletionHandlerCallback<R,A> Runnable callback that wraps aCompletionHandler
and an attachment.JimfsFileChannel AFileChannel
implementation that reads and writes to aRegularFile
object.JimfsFileChannel.FakeFileLock A file lock that does nothing, since only one JVM process has access to this file system.JimfsFileStore FileStore
implementation which provides methods for file creation, lookup and attribute handling.JimfsFileSystem FileSystem
implementation for Jimfs.JimfsFileSystemProvider FileSystemProvider
implementation for Jimfs.JimfsFileSystems Initializes and configures new file system instances.JimfsInputStream InputStream
for reading from a file'sRegularFile
.JimfsOutputStream OutputStream
for writing to aRegularFile
.JimfsPath Jimfs implementation ofPath
.JimfsSecureDirectoryStream Secure directory stream implementation that uses aFileSystemView
with the stream's directory as its working directory.Name Immutable representation of a file name.Options Utility methods for normalizing user-provided options arrays and sets to canonical immutable sets of options.OwnerAttributeProvider Attribute provider that provides theFileOwnerAttributeView
("owner").OwnerAttributeProvider.View Implementation ofFileOwnerAttributeView
.PathMatchers PathMatcher
factory for any file system.PathMatchers.RegexPathMatcher PathMatcher
that matches thetoString()
form of aPath
against a regexPattern
.PathService Service for creatingJimfsPath
instances and handling other path-related operations.PathType An object defining a specific type of path.PathType.ParseResult Simple result of parsing a path.PathURLConnection URLConnection
implementation.PollingWatchService Implementation ofWatchService
that polls for changes to directories at registered paths.PosixAttributeProvider Attribute provider that provides thePosixFileAttributeView
("posix") and allows reading ofPosixFileAttributes
.PosixAttributeProvider.Attributes Implementation ofPosixFileAttributes
.PosixAttributeProvider.View Implementation ofPosixFileAttributeView
.RegularFile A mutable, resizable store for bytes.StandardAttributeProviders Static registry ofAttributeProvider
implementations for the standard set of file attribute views Jimfs supports.SymbolicLink A symbolic link file, containing a path.SystemJimfsFileSystemProvider FileSystemProvider
implementation for Jimfs that is loaded by the system as a service.UnixAttributeProvider Attribute provider that provides the "unix" attribute view.UnixPathType Unix-style path type.UserDefinedAttributeProvider Attribute provider that provides theUserDefinedFileAttributeView
("user").UserDefinedAttributeProvider.View Implementation ofUserDefinedFileAttributeView
.UserLookupService UserPrincipalLookupService
implementation.UserLookupService.JimfsGroupPrincipal GroupPrincipal
implementation.UserLookupService.JimfsUserPrincipal UserPrincipal
implementation.UserLookupService.NamedPrincipal Base class forUserPrincipal
andGroupPrincipal
implementations.Util Miscellaneous static utility methods.WatchServiceConfiguration Configuration for theWatchService
implementation used by a file system.WatchServiceConfiguration.PollingConfig Implementation forWatchServiceConfiguration.polling(long, java.util.concurrent.TimeUnit)
.WindowsPathType Windows-style path type. -
Enum Summary Enum Description AbstractWatchService.Key.State AttributeCopyOption Options for how to handle copying of file attributes when copying a file.Feature Optional file system features that may be supported or unsupported by a Jimfs file system instance.FileSystemView.DeleteMode Mode for deleting.PathNormalization Normalizations that can be applied to names in paths.SystemFileTimeSource Implementation of ofFileTimeSource
that gets the current time from the system. -
Annotation Types Summary Annotation Type Description GuardedBy Indicates that the annotated element should be used only while holding the specified lock.