Package ghidra.app.util.bin
Class ByteArrayProvider
- java.lang.Object
-
- ghidra.app.util.bin.ByteArrayProvider
-
- All Implemented Interfaces:
ByteProvider,java.io.Closeable,java.lang.AutoCloseable
public class ByteArrayProvider extends java.lang.Object implements ByteProvider
An implementation of ByteProvider where the underlying bytes are supplied by a static byte array. NOTE: Use of this class is discouraged when the byte array could be large.
-
-
Constructor Summary
Constructors Constructor Description ByteArrayProvider(byte[] bytes)Constructs a byte array provider using the specified byte arrayByteArrayProvider(java.lang.String name, byte[] bytes)Constructs a byte array provider using the specified byte array
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Releases any resources the provider may have occupied.java.lang.StringgetAbsolutePath()Returns the absolute path (similar to, but not a, URI) to the byte provider.java.io.FilegetFile()Returns the underlying file for this byte provider.java.io.InputStreamgetInputStream(long index)Returns an input stream to the underlying byte provider starting at the specified indexjava.lang.StringgetName()Returns the name of the byte provider.booleanisValidIndex(long index)Returns true if the specified index is valid.longlength()Returns the length of the underlying provider.bytereadByte(long index)Reads a byte at the specified index.byte[]readBytes(long index, long length)Reads a byte array at the specified index.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface ghidra.app.util.bin.ByteProvider
getFSRL
-
-
-
-
Constructor Detail
-
ByteArrayProvider
public ByteArrayProvider(byte[] bytes)
Constructs a byte array provider using the specified byte array- Parameters:
bytes- the underlying byte array.
-
ByteArrayProvider
public ByteArrayProvider(java.lang.String name, byte[] bytes)Constructs a byte array provider using the specified byte array- Parameters:
bytes- the underlying byte array.
-
-
Method Detail
-
close
public void close()
Description copied from interface:ByteProviderReleases any resources the provider may have occupied.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfaceByteProvider- Specified by:
closein interfacejava.io.Closeable
-
getFile
public java.io.File getFile()
Description copied from interface:ByteProviderReturns the underlying file for this byte provider. Or null if this byte provider is not associated with a file.- Specified by:
getFilein interfaceByteProvider- Returns:
- the underlying file for this byte provider
-
getName
public java.lang.String getName()
Description copied from interface:ByteProviderReturns the name of the byte provider. For example, the underlying file name.- Specified by:
getNamein interfaceByteProvider- Returns:
- the name of the byte provider or null
-
getAbsolutePath
public java.lang.String getAbsolutePath()
Description copied from interface:ByteProviderReturns the absolute path (similar to, but not a, URI) to the byte provider. For example, the complete path to the file.- Specified by:
getAbsolutePathin interfaceByteProvider- Returns:
- the absolute path to the byte provider or null
-
getInputStream
public java.io.InputStream getInputStream(long index) throws java.io.IOExceptionDescription copied from interface:ByteProviderReturns an input stream to the underlying byte provider starting at the specified indexThe caller is responsible for closing the returned
InputStreaminstance.- Specified by:
getInputStreamin interfaceByteProvider- Parameters:
index- the index to initialize the input stream- Returns:
- the input stream
- Throws:
java.io.IOException- if an I/O error occurs
-
length
public long length()
Description copied from interface:ByteProviderReturns the length of the underlying provider.- Specified by:
lengthin interfaceByteProvider- Returns:
- the length of the underlying provider
-
isValidIndex
public boolean isValidIndex(long index)
Description copied from interface:ByteProviderReturns true if the specified index is valid.- Specified by:
isValidIndexin interfaceByteProvider- Parameters:
index- the index in the byte provider- Returns:
- returns true if the specified index is valid
-
readByte
public byte readByte(long index) throws java.io.IOExceptionDescription copied from interface:ByteProviderReads a byte at the specified index.- Specified by:
readBytein interfaceByteProvider- Parameters:
index- the index to read the byte- Returns:
- the byte read from the specified index
- Throws:
java.io.IOException- if an I/O error occurs
-
readBytes
public byte[] readBytes(long index, long length) throws java.io.IOExceptionDescription copied from interface:ByteProviderReads a byte array at the specified index.- Specified by:
readBytesin interfaceByteProvider- Parameters:
index- the index to read the byte arraylength- the number of elements to read- Returns:
- the byte array read from the specified index
- Throws:
java.io.IOException- if an I/O error occurs
-
-