Index

A B C D E F G H I J L M N O P R S T U V W 
All Classes|All Packages|Constant Field Values|Serialized Form

A

AbstractCartridge - Class in me.hugmanrique.cartage
Skeleton Cartridge implementation.
AbstractCartridge(MemorySegment) - Constructor for class me.hugmanrique.cartage.AbstractCartridge
 
AbstractCartridge(MemorySegment, ByteOrder) - Constructor for class me.hugmanrique.cartage.AbstractCartridge
 
ACCELEROMETER - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 

B

BANDAI_TAMA5 - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
BufferUtils - Class in me.hugmanrique.cartage.util
Provides memory handling-related utilities.

C

Cartridge - Interface in me.hugmanrique.cartage
Represents the contents of a cartridge as a byte buffer.
checksum() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the checksum of some header data.
checksum() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the checksum of some header data.
clearDacs() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Disables the debugging handler.
close() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
close() - Method in interface me.hugmanrique.cartage.Cartridge
Closes the cartridge.
code() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the 4-character uppercase UTTD code.
compress(Cartridge, int) - Method in interface me.hugmanrique.cartage.compression.Compressor
 
compress(Cartridge, long, int) - Method in interface me.hugmanrique.cartage.compression.Compressor
 
Compressor - Interface in me.hugmanrique.cartage.compression
Compresses data from a Cartridge.
computeChecksum() - Method in interface me.hugmanrique.cartage.gb.GBCartridge
Computes the checksum of the ROM contents.
computeChecksum() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Computes the checksum of some header data (as returned by GBCartridge.Header.checksum()) from the current header contents.
computeChecksum() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Computes the checksum of some header data (as returned by GBACartridge.Header.checksum()) from the current header contents.
copyByteByByte(byte[], int, int, int) - Static method in class me.hugmanrique.cartage.util.BufferUtils
Copies the contents from the specified array byte-by-byte, beginning at the specified position, to the specified position of the array.
copyFrom(MemorySegment) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
copyFrom(MemorySegment) - Method in interface me.hugmanrique.cartage.Cartridge
Copies the contents from the given segment to this cartridge.
copyTo(OutputStream) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
copyTo(OutputStream) - Method in interface me.hugmanrique.cartage.Cartridge
Copies the cartridge contents to the given stream.
copyTo(Path) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
copyTo(Path) - Method in interface me.hugmanrique.cartage.Cartridge
Copies the cartridge contents to the given path.
copyTo(MemorySegment) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
copyTo(MemorySegment) - Method in interface me.hugmanrique.cartage.Cartridge
Copies the cartridge contents to the given segment.

D

dacs() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the type of the DACS memory, if any.
decompress(Cartridge) - Method in interface me.hugmanrique.cartage.compression.Decompressor
Decompresses data starting at the current offset of the given cartridge.
decompress(Cartridge) - Method in class me.hugmanrique.cartage.compression.GBADiffUnfilterer
 
decompress(Cartridge) - Method in class me.hugmanrique.cartage.compression.GBAHuffmanDecompressor
 
decompress(Cartridge) - Method in class me.hugmanrique.cartage.compression.GBALZSSDecompressor
 
decompress(Cartridge) - Method in class me.hugmanrique.cartage.compression.GBALZXDecompressor
 
decompress(Cartridge) - Method in class me.hugmanrique.cartage.compression.GBARLDecompressor
 
decompress(Cartridge, long) - Method in interface me.hugmanrique.cartage.compression.Decompressor
Decompresses data starting at the given offset from the given cartridge.
DecompressionException - Exception in me.hugmanrique.cartage.compression
Indicates an error occurred while attempting to decompress data from a Cartridge.
DecompressionException(String) - Constructor for exception me.hugmanrique.cartage.compression.DecompressionException
Constructs a decompression exception with the given detail message and no cause.
DecompressionException(String, Throwable) - Constructor for exception me.hugmanrique.cartage.compression.DecompressionException
Constructs a decompression exception with the given detail message and cause.
Decompressor - Interface in me.hugmanrique.cartage.compression
Decompresses data from a Cartridge.
destination() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the destination code.
destination() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the cartridge distribution region, derived from the UTTD code.

E

E_READER - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 
EIGHT_MBIT - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
 
ENTRY_INSTRUCTION_ADDR - Static variable in interface me.hugmanrique.cartage.gba.GBACartridge.Header
The address at which a B instruction branching to the start address of the cartridge is written.
entryPoint() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the address to which the console's boot procedure jumps after initialization.
entryPoint() - Method in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
Returns the debugging handler's entry point address.
entryPoint() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the address to which the console's boot procedure jumps after initialization.
EUROPE - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
 

F

FRANCE - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
 
FUTURE - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 

G

GBACartridge - Interface in me.hugmanrique.cartage.gba
A Game Boy Advance cartridge.
GBACartridge.DACSType - Enum Class in me.hugmanrique.cartage.gba
Indicates the entry point and size of the Debugging and Communication System (DACS) memory, used by the Nintendo hardware debugger when the debugging handler is enabled.
GBACartridge.Destination - Enum Class in me.hugmanrique.cartage.gba
The world region where a cartridge is distributed.
GBACartridge.Header - Interface in me.hugmanrique.cartage.gba
The header of a Game Boy Advance cartridge.
GBACartridge.Type - Enum Class in me.hugmanrique.cartage.gba
Specifies additional hardware present in the cartridge.
GBADiffUnfilterer - Class in me.hugmanrique.cartage.compression
Implements the DiffUnFilter algorithms with 8-bit and 16-bit data sizes, present in the BIOS of the GBA and Nintendo DS.
GBAHuffmanDecompressor - Class in me.hugmanrique.cartage.compression
Implements the HuffUnCompRead algorithm, present in the BIOS of the GBA and Nintendo DS.
GBALZSSDecompressor - Class in me.hugmanrique.cartage.compression
Implements the LZ77UnCompRead algorithm, present in the BIOS of the GBA and Nintendo DS.
GBALZXDecompressor - Class in me.hugmanrique.cartage.compression
Implements the LZX decompression algorithm in big-endian mode, used in some Nintendo DS games.
GBARLDecompressor - Class in me.hugmanrique.cartage.compression
Implements the RLUnCompRead algorithm, present in the BIOS of the GBA and Nintendo DS.
gbc() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the value of the GBC flag.
GBCartridge - Interface in me.hugmanrique.cartage.gb
A Game Boy cartridge.
GBCartridge.Header - Interface in me.hugmanrique.cartage.gb
The header of a Game Boy cartridge.
GBCartridge.Type - Enum Class in me.hugmanrique.cartage.gb
Specifies the memory bank controller (if any) and other hardware present in the cartridge.
GERMANY - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
 
get() - Static method in class me.hugmanrique.cartage.compression.GBADiffUnfilterer
Returns an unfilterer instance.
get() - Static method in class me.hugmanrique.cartage.compression.GBAHuffmanDecompressor
Returns a decompressor instance.
get() - Static method in class me.hugmanrique.cartage.compression.GBALZSSDecompressor
Returns a decompressor instance.
get() - Static method in class me.hugmanrique.cartage.compression.GBALZXDecompressor
Returns a decompressor instance.
get() - Static method in class me.hugmanrique.cartage.compression.GBARLDecompressor
Returns a decompressor instance.
getAscii(long, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getAscii(long, int) - Method in interface me.hugmanrique.cartage.Cartridge
Decodes length bytes to characters using the StandardCharsets.US_ASCII charset, beginning at the given offset in the cartridge.
getByte(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getByte(long) - Method in interface me.hugmanrique.cartage.Cartridge
Reads the byte at the given offset.
getBytes(long, byte[]) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getBytes(long, byte[]) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers bytes from the cartridge into the given array, beginning at the given offset in the cartridge.
getBytes(long, byte[], int, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getBytes(long, byte[], int, int) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers length bytes from the cartridge into the given array, beginning at the given offset in the cartridge and at the given offset in the array.
getInt(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getInt(long) - Method in interface me.hugmanrique.cartage.Cartridge
Reads the int at the given offset.
getLong(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getLong(long) - Method in interface me.hugmanrique.cartage.Cartridge
Reads the long at the given offset.
getShort(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getShort(long) - Method in interface me.hugmanrique.cartage.Cartridge
Reads the short at the given offset.
getString(long, int, Charset) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getString(long, int, Charset) - Method in interface me.hugmanrique.cartage.Cartridge
Decodes length bytes to characters using the given charset, beginning at the given offset in the cartridge.
getUnsignedByte(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getUnsignedByte(long) - Method in interface me.hugmanrique.cartage.Cartridge
Reads the unsigned byte at the given offset.
getUnsignedInt(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getUnsignedInt(long) - Method in interface me.hugmanrique.cartage.Cartridge
Reads the unsigned int at the given offset.
getUnsignedShort(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getUnsignedShort(long) - Method in interface me.hugmanrique.cartage.Cartridge
Reads the unsigned short at the given offset.
getUtf8(long, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
getUtf8(long, int) - Method in interface me.hugmanrique.cartage.Cartridge
Decodes length bytes to characters using the StandardCharsets.UTF_8 charset, beginning at the given offset in the cartridge.
getValidLogo() - Static method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the Nintendo logo expected by the console.
getValidLogo() - Static method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the Nintendo logo expected by the console, with debugging mode disabled.
globalChecksum() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the checksum of the entire ROM.

H

hasColorFunctions() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns whether the cartridge supports GBC functions.
hasMemoryBankController() - Method in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
Returns whether the cartridge contains a memory bank controller.
hasRemaining() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
hasRemaining() - Method in interface me.hugmanrique.cartage.Cartridge
Returns whether there exist any bytes between the current offset and the end of the cartridge.
hasSuperFunctions() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns whether the cartridge supports SGB functions.
header() - Method in interface me.hugmanrique.cartage.gb.GBCartridge
Returns the cartridge header.
header() - Method in interface me.hugmanrique.cartage.gba.GBACartridge
Returns the cartridge header.
HUC1_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
HUC3 - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 

I

isPowerOf2(int) - Static method in class me.hugmanrique.cartage.util.NumberUtils
Returns whether the given value is a power of 2.
ITALY - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
 

J

JAPAN - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
 
japaneseDistribution() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns whether the cartridge is supposed to be sold in Japan.

L

licensee() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the licensee code, which indicates the company or publisher of the cartridge.
licensee() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the 2-character uppercase licensee code, which indicates the company or publisher of the cartridge; also known as the maker code.
logo() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the Nintendo logo bitmap.
logo() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the Nintendo logo bitmap.
logo(byte[]) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Copies the Nintendo logo bitmap into the given array.
logo(byte[]) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Copies the Nintendo logo into the given array.
LOGO_LENGTH - Static variable in interface me.hugmanrique.cartage.gb.GBCartridge.Header
The number of bytes reserved for the Nintendo logo.
LOGO_LENGTH - Static variable in interface me.hugmanrique.cartage.gba.GBACartridge.Header
The number of bytes reserved for the Nintendo logo.

M

manufacturer() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the 4-character uppercase manufacturer code, only present in GBC cartridges.
MAX_RAM_BYTES - Static variable in interface me.hugmanrique.cartage.gb.GBCartridge.Header
The maximum RAM size, in bytes.
MAX_ROM_BYTES - Static variable in interface me.hugmanrique.cartage.gb.GBCartridge.Header
The maximum ROM size, in bytes.
MBC1 - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC1_RAM - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC1_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC2 - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC2_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC3 - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC3_RAM - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC3_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC3_RAM_TIMER_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC3_TIMER_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC5 - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC5_RAM - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC5_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC5_RAM_BATTERY_RUMBLE - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC5_RAM_RUMBLE - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC5_RUMBLE - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC6_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MBC7_RAM_BATTERY_ACCELEROMETER - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
me.hugmanrique.cartage - module me.hugmanrique.cartage
 
me.hugmanrique.cartage - package me.hugmanrique.cartage
 
me.hugmanrique.cartage.compression - package me.hugmanrique.cartage.compression
 
me.hugmanrique.cartage.gb - package me.hugmanrique.cartage.gb
 
me.hugmanrique.cartage.gba - package me.hugmanrique.cartage.gba
 
me.hugmanrique.cartage.util - package me.hugmanrique.cartage.util
 
MIN_ROM_BYTES - Static variable in interface me.hugmanrique.cartage.gb.GBCartridge.Header
The minimum ROM size, in bytes.
MMM01 - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MMM01_RAM - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
MMM01_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 

N

NES_EMULATOR - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 
NEW - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 
NumberUtils - Class in me.hugmanrique.cartage.util
Provides methods that operate on numeric values.

O

of(byte) - Static method in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
Returns the cartridge type identified by the given value.
of(byte) - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
Returns the DACS type identified by the given value.
of(byte) - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
Returns the destination identified by the given value.
of(byte) - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
Returns the cartridge type identified by the given value.
offset() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
offset() - Method in interface me.hugmanrique.cartage.Cartridge
Returns the cartridge's offset.
OLD - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 
ONE_MBIT - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
 
order() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
order() - Method in interface me.hugmanrique.cartage.Cartridge
Returns the cartridge's byte order.
order(ByteOrder) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
order(ByteOrder) - Method in interface me.hugmanrique.cartage.Cartridge
Sets the cartridge's byte order.

P

padEnd(String, int, char) - Static method in class me.hugmanrique.cartage.util.StringUtils
Returns a string of the given length, consisting of string followed by as many instances of padChar as necessary to reach that length.
POCKET_CAMERA - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 

R

ramSize() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the RAM size code.
ramSizeBytes() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the RAM size, if any.
read(InputStream) - Static method in interface me.hugmanrique.cartage.gb.GBCartridge
Reads a cartridge from the given stream.
read(InputStream) - Static method in interface me.hugmanrique.cartage.gba.GBACartridge
Reads a cartridge from the given stream.
read(Path) - Static method in interface me.hugmanrique.cartage.gb.GBCartridge
Reads a cartridge from the given path.
read(Path) - Static method in interface me.hugmanrique.cartage.gba.GBACartridge
Reads a cartridge from the given path.
readAscii(int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readAscii(int) - Method in interface me.hugmanrique.cartage.Cartridge
Decodes length bytes to characters using the StandardCharsets.US_ASCII charset, beginning at the cartridge's current offset, which is then incremented by length.
readByte() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readByte() - Method in interface me.hugmanrique.cartage.Cartridge
Reads the byte at the cartridge's current offset, and then increments the offset.
readBytes(byte[]) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readBytes(byte[]) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers bytes from the cartridge into the given array, beginning at the cartridge's current offset, which is then incremented by dest.length.
readBytes(byte[], int, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readBytes(byte[], int, int) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers length bytes from the cartridge into the given array, beginning at the cartridge's current offset and at the given offset in the array.
readInt() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readInt() - Method in interface me.hugmanrique.cartage.Cartridge
Reads the int at the cartridge's current offset, and then increments the offset by Integer.BYTES.
readLong() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readLong() - Method in interface me.hugmanrique.cartage.Cartridge
Reads the long at the cartridge's current offset, and then increments the offset by Long.BYTES.
readShort() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readShort() - Method in interface me.hugmanrique.cartage.Cartridge
Reads the short at the cartridge's current offset, and then increments the offset by Short.BYTES.
readString(int, Charset) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readString(int, Charset) - Method in interface me.hugmanrique.cartage.Cartridge
Decodes length bytes to characters using the given charset, beginning at the cartridge's current offset, which is then incremented by length.
readUnsignedByte() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readUnsignedByte() - Method in interface me.hugmanrique.cartage.Cartridge
Reads the unsigned byte at the cartridge's current offset, and then increments the offset.
readUnsignedInt() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readUnsignedInt() - Method in interface me.hugmanrique.cartage.Cartridge
Reads the unsigned int at the cartridge's current offset, and then increments the offset by Integer.BYTES.
readUnsignedShort() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readUnsignedShort() - Method in interface me.hugmanrique.cartage.Cartridge
Reads the unsigned short at the cartridge's current offset, and then increments the offset by Short.BYTES.
readUtf8(int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
readUtf8(int) - Method in interface me.hugmanrique.cartage.Cartridge
Decodes length bytes to characters using the StandardCharsets.UTF_8 charset, beginning at the cartridge's current offset, which is then incremented by length.
remaining() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
remaining() - Method in interface me.hugmanrique.cartage.Cartridge
Returns the number of bytes between the current offset and the end of the cartridge.
requiredConsole() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the required console model to use the cartridge; also known as the main unit code.
requireLength(CharSequence, int) - Static method in class me.hugmanrique.cartage.util.StringUtils
Ensures the length of the given sequence is length.
requireMaxLength(CharSequence, int) - Static method in class me.hugmanrique.cartage.util.StringUtils
Ensures the length of the given sequence is less than or equal to maxLength.
requiresColor() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns whether the cartridge requires a GBC console to run.
requireUppercaseAscii(String) - Static method in class me.hugmanrique.cartage.util.StringUtils
Ensures the given string is composed of uppercase ASCII characters, spaces, and null terminators (\0).
requireUppercaseAscii(String, boolean) - Static method in class me.hugmanrique.cartage.util.StringUtils
Ensures the given string is composed of uppercase ASCII characters and spaces, ignoring null terminators (\0) if specified.
ROM_ONLY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
ROM_RAM - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
ROM_RAM_BATTERY - Enum constant in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
 
romSize() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the ROM size code.
romSizeBytes() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the ROM size.
RTC_SOLAR - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 
RUMBLE - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 
RUMBLE_GYRO - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
 

S

setAscii(long, CharSequence) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setAscii(long, CharSequence) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the encoded characters using the StandardCharsets.US_ASCII charset, beginning at the given offset in the cartridge.
setByte(long, byte) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setByte(long, byte) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given byte at the given offset.
setBytes(long, byte[]) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setBytes(long, byte[]) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers bytes from the given array into the cartridge, beginning at the given offset in the cartridge.
setBytes(long, byte[], int, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setBytes(long, byte[], int, int) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers length bytes from the given array into the cartridge, beginning at the given offset in the cartridge and at the given offset in the array.
setChecksum() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the header checksum to the value returned by GBCartridge.Header.computeChecksum().
setChecksum() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the header checksum to the value returned by GBACartridge.Header.computeChecksum().
setChecksum(byte) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the header checksum.
setChecksum(byte) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the header checksum.
setCode(String) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the UTTD code.
setDacs(GBACartridge.DACSType) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Enables the debugging handler and sets the given DACS memory type.
setDestination(boolean) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the destination code.
setDestination(GBACartridge.Destination) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the distribution region.
setEntryPoint(int) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the entry point address.
setEntryPoint(short) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the entry point address.
setGbc(byte) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the GBC flag.
setGlobalChecksum(short) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the global checksum.
setInt(long, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setInt(long, int) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given int at the given offset.
setLicensee(String) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the licensee code.
setLogo(byte[]) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the Nintendo logo bitmap.
setLogo(byte[]) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the Nintendo logo bitmap.
setLong(long, long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setLong(long, long) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given long at the given offset.
setManufacturer(String) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the cartridge manufacturer.
setNewLicensee(short) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the licensee code, following the new format.
setOffset(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setOffset(long) - Method in interface me.hugmanrique.cartage.Cartridge
Sets the cartridge's offset.
setOldLicensee(byte) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the licensee code, following the old format.
setRamSize(byte) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the RAM size code.
setRequiredConsole(byte) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the required console model.
setRomSize(byte) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the ROM size code.
setSgb(byte) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the SGB flag.
setShort(long, short) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setShort(long, short) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given short at the given offset.
setShortTitle(String) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the short cartridge title.
setString(long, CharSequence, Charset) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setString(long, CharSequence, Charset) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the encoded characters using the given charset, beginning at the given offset in the cartridge.
setTitle(String) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the cartridge title.
setTitle(String) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the cartridge title.
setType(GBCartridge.Type) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the cartridge type.
setType(GBACartridge.Type) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the cartridge type.
setUnsignedByte(long, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setUnsignedByte(long, int) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given unsigned byte at the given offset.
setUnsignedInt(long, long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setUnsignedInt(long, long) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given unsigned int at the given offset.
setUnsignedShort(long, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setUnsignedShort(long, int) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given unsigned short at the given offset.
setUtf8(long, CharSequence) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
setUtf8(long, CharSequence) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the encoded characters using the StandardCharsets.UTF_8 charset, beginning at the given offset in the cartridge.
setValidLogo() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the valid Nintendo logo.
setValidLogo() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the valid Nintendo logo, with debugging mode disabled.
setVersion(byte) - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Sets the cartridge version.
setVersion(byte) - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Sets the cartridge version.
sgb() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the value of the SGB flag.
shortTitle() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the 2-character uppercase short cartridge title, derived from the UTTD code.
size() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
size() - Method in interface me.hugmanrique.cartage.Cartridge
Returns the size of the cartridge.
size() - Method in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
Returns the DACS flash memory size.
skip(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
skip(long) - Method in interface me.hugmanrique.cartage.Cartridge
Increases the cartridge's offset.
SPAIN - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
 
StringUtils - Class in me.hugmanrique.cartage.util
Provides String-related utilities.

T

title() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the 16-character uppercase cartridge title.
title() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the 12-character uppercase cartridge title.
toString() - Method in class me.hugmanrique.cartage.AbstractCartridge
 
type() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Specifies the type of the cartridge.
type() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the type of the cartridge, derived from the UTTD code.

U

USA - Enum constant in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
 

V

value() - Method in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
Returns the identifier for this cartridge type.
value() - Method in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
Returns the identifier for this DACS type.
value() - Method in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
Returns the identifier for this destination.
value() - Method in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
Returns the identifier for this cartridge type.
valueOf(String) - Static method in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
Returns the enum constant of this class with the specified name.
values() - Static method in enum class me.hugmanrique.cartage.gb.GBCartridge.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.DACSType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.Destination
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.hugmanrique.cartage.gba.GBACartridge.Type
Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in interface me.hugmanrique.cartage.gb.GBCartridge.Header
Returns the cartridge version.
version() - Method in interface me.hugmanrique.cartage.gba.GBACartridge.Header
Returns the cartridge version.

W

writeAscii(CharSequence) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeAscii(CharSequence) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the encoded characters using the StandardCharsets.US_ASCII charset, beginning at the cartridge's current offset, which is then incremented by the number of written bytes.
writeByte(byte) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeByte(byte) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given byte at the cartridge's current offset, and then increments the offset.
writeBytes(byte[]) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeBytes(byte[]) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers the entire content of the given array into the cartridge, beginning at the cartridge's current offset, which is then incremented by source.length.
writeBytes(byte[], int, int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeBytes(byte[], int, int) - Method in interface me.hugmanrique.cartage.Cartridge
Transfers length bytes from the given array into the cartridge, beginning at the cartridge's current offset and at the given offset in the array.
writeInt(int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeInt(int) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given int at the cartridge's current offset, and then increments the offset by Integer.BYTES.
writeLong(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeLong(long) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given long at the cartridge's current offset, and then increments the offset by Long.BYTES.
writeShort(short) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeShort(short) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given short at the cartridge's current offset, and then increments the offset by Short.BYTES.
writeString(CharSequence, Charset) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeString(CharSequence, Charset) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the encoded characters using the given charset, beginning at the cartridge's current offset, which is then incremented by the number of written bytes.
writeUnsignedByte(int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeUnsignedByte(int) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given unsigned byte at the cartridge's current offset, and then increments the offset.
writeUnsignedInt(long) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeUnsignedInt(long) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given unsigned int at the cartridge's current offset, and then increments the offset by Integer.BYTES.
writeUnsignedShort(int) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeUnsignedShort(int) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the given unsigned short at the cartridge's current offset, and then increments the offset by Short.BYTES.
writeUtf8(CharSequence) - Method in class me.hugmanrique.cartage.AbstractCartridge
 
writeUtf8(CharSequence) - Method in interface me.hugmanrique.cartage.Cartridge
Writes the encoded characters using the StandardCharsets.UTF_8 charset, beginning at the cartridge's current offset, which is then incremented by the number of written bytes.
A B C D E F G H I J L M N O P R S T U V W 
All Classes|All Packages|Constant Field Values|Serialized Form