Record Class Instruction

java.lang.Object

java.lang.Record

org.applecommander.disassembler.api.Instruction

Record Components:

address - The starting address for this instruction.

code - The raw bytes representing the instruction.

mnemonic - The opcode mnemonic.

operands - List of operands, assumed to be joined with ",".

description - An optional description given to the opcode.

public record Instruction(int address, byte[] code, String mnemonic, List<Instruction.Operand> operands, Optional<String> description)
extends Record

An instruction represents one decoded lines. It potentially could also be a "directive" (not really, but useful for humans); for example the switching instruction set uses ".6502" and ".SWEET16" to indicate mode switches.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Instruction.Builder
static class	Instruction.OpBuilder
static final record	Instruction.Operand	An operand represents a single operand.

Constructor Summary

Constructors

Constructor	Description
Instruction(int address, byte[] code, String mnemonic, List<Instruction.Operand> operands, Optional<String> description)	Creates an instance of a Instruction record class.

Method Summary

Modifier and Type	Method	Description
int	address()	Returns the value of the address record component.
Optional<Instruction.Operand>	addressRef()
static Instruction.Builder	at(int address)	Initiate construction of an instruction.
byte[]	code()	Returns the value of the code record component.
Optional<String>	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	mnemonic()	Returns the value of the mnemonic record component.
List<Instruction.Operand>	operands()	Returns the value of the operands record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Instruction

public Instruction(int address,
 byte[] code,
 String mnemonic,
 List<Instruction.Operand> operands,
 Optional<String> description)

Creates an instance of a Instruction record class.

Parameters:

address - the value for the address record component

code - the value for the code record component

mnemonic - the value for the mnemonic record component

operands - the value for the operands record component

description - the value for the description record component

Method Details

addressRef

public Optional<Instruction.Operand> addressRef()

at

public static Instruction.Builder at(int address)

Initiate construction of an instruction.

For example (this is fabricated but also gives an idea):

int operandValue = program.peekUnsignedByte(1);
Instruction inst = Instruction.at(program.currentAddress())
                              .code(program.read(2))
                              .mnemonic("LDA")
                              .opValue("#%s", "%d", operandValue)
                              .get();

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

address

public int address()

Returns the value of the address record component.

Returns:

the value of the address record component

code

public byte[] code()

Returns the value of the code record component.

Returns:

the value of the code record component

mnemonic

public String mnemonic()

Returns the value of the mnemonic record component.

Returns:

the value of the mnemonic record component

operands

public List<Instruction.Operand> operands()

Returns the value of the operands record component.

Returns:

the value of the operands record component

description

public Optional<String> description()

Returns the value of the description record component.

Returns:

the value of the description record component