Package ghidra.program.model.pcode
Class StringIngest
java.lang.Object
ghidra.program.model.pcode.StringIngest
- All Implemented Interfaces:
ByteIngest
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clear any previous cached bytes.void
Formal indicator that ingesting of bytes is complete and processing can beginvoid
ingestStream
(InputStream inStream) Ingest bytes from the stream up to (and including) the first 0 byte.boolean
isEmpty()
void
Open the ingester for receiving bytes.toString()
-
Constructor Details
-
StringIngest
public StringIngest() -
StringIngest
-
-
Method Details
-
open
Description copied from interface:ByteIngest
Open the ingester for receiving bytes. This establishes the description of the source of the bytes and maximum number of bytes that can be read- Specified by:
open
in interfaceByteIngest
- Parameters:
max
- is the maximum number of bytes that can be readsrc
- is the description of the byte source
-
ingestStream
Description copied from interface:ByteIngest
Ingest bytes from the stream up to (and including) the first 0 byte. This can be called multiple times to read in bytes in different chunks. An absolute limit is set on the number of bytes that can be ingested via the max parameter to a previous call to open(), otherwise an exception is thrown.- Specified by:
ingestStream
in interfaceByteIngest
- Parameters:
inStream
- is the input stream to read from- Throws:
IOException
- for errors reading from the stream
-
endIngest
public void endIngest()Description copied from interface:ByteIngest
Formal indicator that ingesting of bytes is complete and processing can begin- Specified by:
endIngest
in interfaceByteIngest
-
clear
public void clear()Description copied from interface:ByteIngest
Clear any previous cached bytes.- Specified by:
clear
in interfaceByteIngest
-
toString
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceByteIngest
- Returns:
- true if no bytes have yet been ingested via ingestStream()
-