uk.co.xfactorylibrarians.coremidi4j

Class CoreMidiDeviceInfo

java.lang.Object

javax.sound.midi.MidiDevice.Info

uk.co.xfactorylibrarians.coremidi4j.CoreMidiDeviceInfo

public class CoreMidiDeviceInfo
extends MidiDevice.Info

CoreMidiDeviceInfo class

Field Summary

Fields

Modifier and Type	Field and Description
private String	deviceName
private int	deviceReference
private int	deviceUniqueID
private String	endPointName
private int	endPointReference
private int	endPointUniqueID
private String	entityName
private int	entityReference
private int	entityUniqueID

Constructor Summary

Constructors

Constructor and Description
CoreMidiDeviceInfo(String name, String vendor, String description, String version, String deviceName, int deviceReference, int deviceUniqueID, String entityName, int entityReference, int entityUniqueID, String endPointName, int endPointReference, int endPointUniqueID) Constructs a CoreMidiDeviceInfo object from the parameters

Method Summary

Modifier and Type	Method and Description
private static String	defaultForNull(String value, String fallback) Substitutes a default value if the value is null
String	getDeviceName() Gets the device name
int	getDeviceReference() Gets the deviceReference value
int	getdeviceUniqueID() Gets the OS X unique identifier for the device
String	getEndPointName() Gets the endPoint name
int	getEndPointReference() Gets the endPointReference value
int	getEndPointUniqueID() Gets the OS X unique identifier for the end point
String	getEntityName() Gets the entity name
int	getEntityReference() Gets the entityReference value
int	getEntityUniqueID() Gets the OS X unique identifier for the entity
String	getInformationString() Gets a string describing the device
int	getUniqueID() Deprecated.

Methods inherited from class javax.sound.midi.MidiDevice.Info

equals, getDescription, getName, getVendor, getVersion, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

deviceName

private final String deviceName

deviceReference

private final int deviceReference

deviceUniqueID

private final int deviceUniqueID

entityName

private final String entityName

entityReference

private final int entityReference

entityUniqueID

private final int entityUniqueID

endPointName

private final String endPointName

endPointReference

private final int endPointReference

endPointUniqueID

private final int endPointUniqueID

Constructor Detail

CoreMidiDeviceInfo

public CoreMidiDeviceInfo(String name,
                          String vendor,
                          String description,
                          String version,
                          String deviceName,
                          int deviceReference,
                          int deviceUniqueID,
                          String entityName,
                          int entityReference,
                          int entityUniqueID,
                          String endPointName,
                          int endPointReference,
                          int endPointUniqueID)

Constructs a CoreMidiDeviceInfo object from the parameters

Parameters:

name - The name of the device

vendor - The manufacturer of the device

description - A description of the device

version - The version number of the device driver

deviceName - The raw name of the device

deviceReference - The device reference

deviceUniqueID - The OS X unique identifier for the device

entityName - The raw name of the entity

entityReference - The entity reference

entityUniqueID - The OS X unique identifier for the entity

endPointName - The raw name of the end point

endPointReference - The end point reference

endPointUniqueID - The OS X unique identifier for the end point

Method Detail

defaultForNull

private static String defaultForNull(String value,
                                     String fallback)

Substitutes a default value if the value is null

Parameters:

value - The value which may be null

fallback - The value to use if value is null

Returns:

The value string, or the fallback string if the value is null

getInformationString

public String getInformationString()

Gets a string describing the device

Returns:

A string describing the device

getEndPointName

public String getEndPointName()

Gets the endPoint name

Returns:

the endPoint name

getEndPointReference

public int getEndPointReference()

Gets the endPointReference value

Returns:

the endPointReference value

getEndPointUniqueID

public int getEndPointUniqueID()

Gets the OS X unique identifier for the end point

Returns:

The OS X unique identifier for the end point

getUniqueID

@Deprecated
public int getUniqueID()

Deprecated.

Replaced by getdeviceUniqueID, getEndpointUniqueID.

Returns:

Endpoint Reference UniqueId

getEntityName

public String getEntityName()

Gets the entity name

Returns:

the entity name

getEntityReference

public int getEntityReference()

Gets the entityReference value

Returns:

the entityReference value

getEntityUniqueID

public int getEntityUniqueID()

Gets the OS X unique identifier for the entity

Returns:

The OS X unique identifier for the entity

getDeviceName

public String getDeviceName()

Gets the device name

Returns:

the device name

getDeviceReference

public int getDeviceReference()

Gets the deviceReference value

Returns:

the deviceReference value

getdeviceUniqueID

public int getdeviceUniqueID()

Gets the OS X unique identifier for the device

Returns:

The OS X unique identifier for the device