Class GFileSystemBaseFactory
java.lang.Object
ghidra.formats.gfilesystem.factory.GFileSystemBaseFactory
- All Implemented Interfaces:
GFileSystemFactory<GFileSystemBase>
,GFileSystemFactoryByteProvider<GFileSystemBase>
,GFileSystemProbe
,GFileSystemProbeByteProvider
public class GFileSystemBaseFactory
extends Object
implements GFileSystemFactoryByteProvider<GFileSystemBase>, GFileSystemProbeByteProvider
A
GFileSystemFactory
implementation that probes and creates instances of
GFileSystemBase
which use the legacy filesystem lifecycle pattern.
For each operation, this factory will mint a new instance of a GFileSystemBase-derived fs, using its 3 param constructor, and call its isValid() or open().
After an isValid() call, the newly minted filesystem instance is thrown away.
This class requires special support in the FileSystemFactoryMgr
to push
the fsClass into each factory instance after it is constructed.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(FSRLRoot targetFSRL, ByteProvider byteProvider, FileSystemService fsService, TaskMonitor monitor) Constructs a newGFileSystem
instance that handles the specified file.boolean
probe
(ByteProvider byteProvider, FileSystemService fsService, TaskMonitor monitor) Probes the specifiedByteProvider
to determine if this filesystem implementation can handle the file.void
setFileSystemClass
(Class<? extends GFileSystemBase> fsClass)
-
Constructor Details
-
GFileSystemBaseFactory
public GFileSystemBaseFactory()
-
-
Method Details
-
setFileSystemClass
-
probe
public boolean probe(ByteProvider byteProvider, FileSystemService fsService, TaskMonitor monitor) throws IOException, CancelledException Description copied from interface:GFileSystemProbeByteProvider
Probes the specifiedByteProvider
to determine if this filesystem implementation can handle the file.- Specified by:
probe
in interfaceGFileSystemProbeByteProvider
- Parameters:
byteProvider
- aByteProvider
containing the contents of the file being probed. Implementors of this method should NOTclose()
this object.fsService
- a reference to theFileSystemService
objectmonitor
- aTaskMonitor
that should be polled to see if the user has requested to cancel the operation, and updated with progress information.- Returns:
true
if the specified file is handled by this filesystem implementation,false
if not.- Throws:
IOException
- if there is an error reading files.CancelledException
- if the user cancels
-
create
public GFileSystemBase create(FSRLRoot targetFSRL, ByteProvider byteProvider, FileSystemService fsService, TaskMonitor monitor) throws IOException, CancelledException Description copied from interface:GFileSystemFactoryByteProvider
Constructs a newGFileSystem
instance that handles the specified file.- Specified by:
create
in interfaceGFileSystemFactoryByteProvider<GFileSystemBase>
- Parameters:
targetFSRL
- theFSRLRoot
of the filesystem being created.byteProvider
- aByteProvider
containing the contents of the file being probed. This method is responsible for closing this byte provider instance.fsService
- a reference to theFileSystemService
objectmonitor
- aTaskMonitor
that should be polled to see if the user has requested to cancel the operation, and updated with progress information.- Returns:
- a new
GFileSystem
derived instance. - Throws:
IOException
- if there is an error reading files.CancelledException
- if the user cancels
-