Module de.carne.mcd

Package de.carne.mcd.bootstrap

Class InstructionIndexBuilder

java.lang.Object

de.carne.mcd.bootstrap.InstructionIndexBuilder

All Implemented Interfaces:

InstructionIndexParameters

public final class InstructionIndexBuilder
extends java.lang.Object
implements InstructionIndexParameters

Helper class used to create an InstructionIndex resource file.

Constructor Summary

Constructors

Constructor	Description
InstructionIndexBuilder()

Method Summary

Modifier and Type	Method	Description
void	add(InstructionOpcode opcode, Instruction instruction)	Adds an InstructionOpcode to Instruction mapping to the index.
int	entryCount()	Gets the number instructions stored in this index.
int	opcodeBytes()	Gets the number of bytes used to encode an InstructionOpcode in the index's lookup table.
int	positionBytes()	Gets the number of bytes used to encode a file position in the index's lookup table.
long	save(java.io.File file)	Saves the current state of this instance to a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.carne.mcd.instruction.InstructionIndexParameters

parameters

Constructor Detail

InstructionIndexBuilder

public InstructionIndexBuilder()

Method Detail

add

public void add(InstructionOpcode opcode,
                Instruction instruction)
         throws java.io.IOException

Adds an InstructionOpcode to Instruction mapping to the index.

Parameters:

opcode - the InstructionOpcode to map from.

instruction - the Instruction to map to.

Throws:

java.io.IOException - if an I/O error occurs.

save

public long save(java.io.File file)
          throws java.io.IOException

Saves the current state of this instance to a file.

The resulting output can accessed via InstructionIndex.open(InstructionFactory, java.net.URL).

Parameters:

file - the file write to.

Returns:

the size of the stored index.

Throws:

java.io.IOException - if an I/O error occurs.

entryCount

public int entryCount()

Description copied from interface: InstructionIndexParameters

Gets the number instructions stored in this index.

Specified by:

entryCount in interface InstructionIndexParameters

Returns:

the number instructions stored in this index.

opcodeBytes

public int opcodeBytes()

Description copied from interface: InstructionIndexParameters

Gets the number of bytes used to encode an InstructionOpcode in the index's lookup table.

Specified by:

opcodeBytes in interface InstructionIndexParameters

Returns:

the number of bytes used to encode an InstructionOpcode in the index's lookup table.

positionBytes

public int positionBytes()

Description copied from interface: InstructionIndexParameters

Gets the number of bytes used to encode a file position in the index's lookup table.

Specified by:

positionBytes in interface InstructionIndexParameters

Returns:

the number of bytes used to encode a file position in the index's lookup table.