IMessageType (Midica 1.5.4

All Known Implementing Classes:

MessageTreeNode, SingleMessage
```
public interface IMessageType
```
This interface represents a certain type of MIDI message. It can be implemented by classes representing either a single MIDI message or a certain type of messages.

It’s implemented by the following classes:
- MessageTreeNode – represents a type of MIDI messages
- SingleMessage – represents a certain MIDI message
The implementing classes provide different kinds of options. Each option has a certain (arbitrary) ID and a value. Depending on the kind of option, the value can be a single value, a list of values or a range of values.

If the class represents a certain MIDI message, the value is always a single value and never a list or range.

Jan Trukenmüller

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OPT_CHANNEL`
`static int`	`OPT_CONTROLLER`
`static int`	`OPT_LEAF_NODE`
`static int`	`OPT_LENGTH`
`static int`	`OPT_MESSAGE`
`static int`	`OPT_META_TYPE`
`static int`	`OPT_MSG_NUM`
`static int`	`OPT_NRPN`
`static int`	`OPT_RPN`
`static int`	`OPT_STATUS_BYTE`
`static int`	`OPT_SUB_ID_1`
`static int`	`OPT_SUB_ID_2`
`static int`	`OPT_SUMMARY`
`static int`	`OPT_SYSEX_CHANNEL`
`static int`	`OPT_TEMPO_BPM`
`static int`	`OPT_TEMPO_MPQ`
`static int`	`OPT_TEXT`
`static int`	`OPT_TICK`
`static int`	`OPT_TRACK`
`static int`	`OPT_VENDOR_ID`
`static int`	`OPT_VENDOR_NAME`
`static int[]`	`OPTIONS` Contains all option IDs in the right order.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDistinctOptions(int id)` Returns the given option’s value, list or null.
`java.lang.String`	`getDistinctOptions(int id, java.lang.String separator)` Returns the given option’s value, list or null.
`java.lang.Object`	`getOption(int id)` Returns the value of a single option.
`java.lang.String`	`getRange(int id)` Returns the given option’s value, range or null.

- Field Detail
  - OPT_TICK
```
static final int OPT_TICK
```
    See Also:
    
    Constant Field Values
  - OPT_TRACK
```
static final int OPT_TRACK
```
    See Also:
    
    Constant Field Values
  - OPT_MSG_NUM
```
static final int OPT_MSG_NUM
```
    See Also:
    
    Constant Field Values
  - OPT_LEAF_NODE
```
static final int OPT_LEAF_NODE
```
    See Also:
    
    Constant Field Values
  - OPT_STATUS_BYTE
```
static final int OPT_STATUS_BYTE
```
    See Also:
    
    Constant Field Values
  - OPT_META_TYPE
```
static final int OPT_META_TYPE
```
    See Also:
    
    Constant Field Values
  - OPT_VENDOR_ID
```
static final int OPT_VENDOR_ID
```
    See Also:
    
    Constant Field Values
  - OPT_VENDOR_NAME
```
static final int OPT_VENDOR_NAME
```
    See Also:
    
    Constant Field Values
  - OPT_SUB_ID_1
```
static final int OPT_SUB_ID_1
```
    See Also:
    
    Constant Field Values
  - OPT_SUB_ID_2
```
static final int OPT_SUB_ID_2
```
    See Also:
    
    Constant Field Values
  - OPT_CONTROLLER
```
static final int OPT_CONTROLLER
```
    See Also:
    
    Constant Field Values
  - OPT_MESSAGE
```
static final int OPT_MESSAGE
```
    See Also:
    
    Constant Field Values
  - OPT_CHANNEL
```
static final int OPT_CHANNEL
```
    See Also:
    
    Constant Field Values
  - OPT_LENGTH
```
static final int OPT_LENGTH
```
    See Also:
    
    Constant Field Values
  - OPT_SYSEX_CHANNEL
```
static final int OPT_SYSEX_CHANNEL
```
    See Also:
    
    Constant Field Values
  - OPT_RPN
```
static final int OPT_RPN
```
    See Also:
    
    Constant Field Values
  - OPT_NRPN
```
static final int OPT_NRPN
```
    See Also:
    
    Constant Field Values
  - OPT_TEXT
```
static final int OPT_TEXT
```
    See Also:
    
    Constant Field Values
  - OPT_TEMPO_MPQ
```
static final int OPT_TEMPO_MPQ
```
    See Also:
    
    Constant Field Values
  - OPT_TEMPO_BPM
```
static final int OPT_TEMPO_BPM
```
    See Also:
    
    Constant Field Values
  - OPT_SUMMARY
```
static final int OPT_SUMMARY
```
    See Also:
    
    Constant Field Values
  - OPTIONS
```
static final int[] OPTIONS
```
    Contains all option IDs in the right order.
- Method Detail
  - getOption
```
java.lang.Object getOption(int id)
```
    Returns the value of a single option.
    
    Parameters:
    
    id - The option ID.
    
    Returns:
    
    the option value or null if not available.
  - getRange
```
java.lang.String getRange(int id)
```
    Returns the given option’s value, range or null.
    - Returns null, if an option with this ID is not available.
    - Returns a single value, if the class represents only one message, or if the minimum and maximum values are identical.
    - Otherwise, returns a value range.
    Parameters:
    
    id - The option ID.
    
    Returns:
    
    value, range or null, as described above.
  - getDistinctOptions
```
java.lang.String getDistinctOptions(int id)
```
    Returns the given option’s value, list or null.
    - Returns null, if an option with this ID is not available.
    - Returns a single value, if the class represents only one message, or if only one value with this ID exists.
    - Otherwise, returns a value list.
    Same as getDistinctOptions(int, String) using "**, **" as the separator.
    Parameters:
    
    id - The option ID.
    
    Returns:
    
    value, list or null, as described above.
  - getDistinctOptions
```
java.lang.String getDistinctOptions(int id,
                                    java.lang.String separator)
```
    Returns the given option’s value, list or null.
    - Returns null, if an option with this ID is not available.
    - Returns a single value, if the class represents only one message, or if only one value with this ID exists.
    - Otherwise, returns a value list.
    Parameters:
    
    id - The option ID.
    
    separator - The string to be used in order to separate the values.
    
    Returns:
    
    value, list or null, as described above.

Interface IMessageType

Field Summary

Method Summary

Field Detail

OPT_TICK

OPT_TRACK

OPT_MSG_NUM

OPT_LEAF_NODE

OPT_STATUS_BYTE

OPT_META_TYPE

OPT_VENDOR_ID

OPT_VENDOR_NAME

OPT_SUB_ID_1

OPT_SUB_ID_2

OPT_CONTROLLER

OPT_MESSAGE

OPT_CHANNEL

OPT_LENGTH

OPT_SYSEX_CHANNEL

OPT_RPN

OPT_NRPN

OPT_TEXT

OPT_TEMPO_MPQ

OPT_TEMPO_BPM

OPT_SUMMARY

OPTIONS

Method Detail

getOption

getRange

getDistinctOptions

getDistinctOptions