org.jsynthlib.midi.service

Class MidiMessageFormatter

java.lang.Object

org.jsynthlib.midi.service.MidiMessageFormatter

public final class MidiMessageFormatter
extends Object

Class to format MIDI messages into Strings.

Author:

Pascal Collberg

Method Summary

Modifier and Type	Method and Description
static String	hexDump(byte[] d, int offset, int len, int bytes) convert a byte array into a hexa-dump string.
static String	hexDump(byte[] d, int offset, int len, int bytes, boolean wantspaces) convert a byte array into a hexa-dump string, with or without spaces between the bytes.
static String	hexDump(byte[] d, int offset, int len, int bytes, boolean addresses, boolean characters) convert a byte array into a string of hex values, optionally including their character equivalents and/or the address/offset of the beginning of the line.
static String	hexDump(byte[] d, int offset, int len, int bytes, int addressLength, boolean characters)
static String	hexDumpOneLine(byte[] d, int offset, int len, int bytes) convert a byte array into a one-line hexa-dump string.
static String	midiMessageToString(MidiMessage m, boolean completeMessage) convert MidiMessage into a string.
static String	shortMessageToString(ShortMessage m) Convert ShortMessage into a hexa-dump string.
static String	statusString(MidiMessage m) Return a String of the name of status byte of a MidiMessage.
static String	sysexMessageToString(SysexMessage m) Convert SysexMessage into a hexa-dump string.
static String	sysexMessageToString(SysexMessage m, int bytes) Convert SysexMessage into a hexa-dump string.

Methods inherited from class java.lang.Object

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

Method Detail

hexDump

public static String hexDump(byte[] d,
                             int offset,
                             int len,
                             int bytes,
                             boolean wantspaces)

convert a byte array into a hexa-dump string, with or without spaces between the bytes.

Parameters:

d - a byte[] array to be converted.

offset - array index from which dump starts.

len - number of bytes to be dumped. If -1, dumps to the end of the array.

bytes - number of bytes per line. If equal or less than 0, no newlines are inserted.

wantspaces - whether or not to insert spaces between bytes

Returns:

hexa-dump string.

hexDump

public static String hexDump(byte[] d,
                             int offset,
                             int len,
                             int bytes,
                             int addressLength,
                             boolean characters)

hexDump

public static String hexDump(byte[] d,
                             int offset,
                             int len,
                             int bytes,
                             boolean addresses,
                             boolean characters)

convert a byte array into a string of hex values, optionally including their character equivalents and/or the address/offset of the beginning of the line. With character equivalents, unprintable characters are replaced by spaces. For example: 65 78 61 6D 70 6C 65 01 EF 31 38 F3 F1 - EXAMPLE..18.. If addresses is true, then the hex representation of the offset will be put at the beginning of each line. For example: 013A0 - 65 78 61 6D 70 6C 65 01 - EXAMPLE. 013A8 - EF 31 38 F3 F1 65 64 63 - .18..EDC 013B0 - 38 34 36 37 38 31 37 37 - 84678177 If len is positive non-zero, only len bytes will be represented on each line.

Parameters:

d - a byte[] array to be converted.

offset - array index from which dump starts.

len - number of bytes to be dumped. If -1, dumps to the end of the array.

bytes - number of columns (bytes) to put in each line. If less than or equal to zero, no line-breaks are inserted.

Returns:

hexa-dump string.

hexDump

public static String hexDump(byte[] d,
                             int offset,
                             int len,
                             int bytes)

convert a byte array into a hexa-dump string.

Parameters:

d - a byte[] array to be converted.

offset - array index from which dump starts.

len - number of bytes to be dumped. If -1, dumps to the end of the array.

bytes - number of bytes per line. If equal or less than 0, no newlines are inserted.

Returns:

hexa-dump string.

hexDumpOneLine

public static String hexDumpOneLine(byte[] d,
                                    int offset,
                                    int len,
                                    int bytes)

convert a byte array into a one-line hexa-dump string. If it's longer than len, it will have the inner portion removed and replaced with dots, for example: "00 01 03 04 05 .. 7d 7e 7f"

Parameters:

d - a byte[] array to be converted.

offset - array index from which dump starts.

len - number of bytes to be dumped. If -1, dumps to the end of the array.

bytes - number of columns (bytes) to put in the one-line string.

Returns:

hexa-dump string.

sysexMessageToString

public static String sysexMessageToString(SysexMessage m,
                                          int bytes)

Convert SysexMessage into a hexa-dump string.

Parameters:

m - a SysexMessage value

bytes - number of bytes per line. If equal or less than 0, no newlines are inserted.

Returns:

a String value

sysexMessageToString

public static String sysexMessageToString(SysexMessage m)
                                   throws InvalidMidiDataException

Convert SysexMessage into a hexa-dump string. If the length is longer than 16bytes, bytes of middle of the array are not ignored.

Parameters:

m - a SysexMessage value

Returns:

a String value

Throws:

InvalidMidiDataException - if an error occurs

shortMessageToString

public static String shortMessageToString(ShortMessage m)
                                   throws InvalidMidiDataException

Convert ShortMessage into a hexa-dump string.

Parameters:

m - a ShortMessage value

Returns:

a String value

Throws:

InvalidMidiDataException - if an error occurs

statusString

public static String statusString(MidiMessage m)
                           throws InvalidMidiDataException

Return a String of the name of status byte of a MidiMessage.

Parameters:

m - a MidiMessage value

Returns:

a String value

Throws:

InvalidMidiDataException - if an error occurs

midiMessageToString

public static String midiMessageToString(MidiMessage m,
                                         boolean completeMessage)
                                  throws InvalidMidiDataException

convert MidiMessage into a string.

Parameters:

m - a MidiMessage value

Returns:

a String value

Throws:

InvalidMidiDataException