net.charlesames.music.midi
Class MidiEntity

java.lang.Object
  extended by net.charlesames.utility.common.Disposable
      extended by net.charlesames.music.midi.MidiEntity
Direct Known Subclasses:
MidiChannel, MidiDevice, MidiFile, MidiTrack, MidiTrackEvent

public abstract class MidiEntity
extends Disposable

Base class for MIDI entities.

Author:
Charles Ames

Constructor Summary
MidiEntity(MidiEntity container, int id, java.lang.String name)
          Constructor for MidiEntity instances.
 
Method Summary
 void dispose()
          Release resources engaged by this object, thus rendering it amenable to garbage collection.
 MidiEntity getContainer()
          Get the MidiEntity which contains this instance.
 int getID()
          Get the instance id.
 java.lang.String getName()
          Get the instance name.
 void setName(java.lang.String name)
          Set the instance name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MidiEntity

public MidiEntity(MidiEntity container,
                  int id,
                  java.lang.String name)
Constructor for MidiEntity instances.

Parameters:
container - The MidiEntity which contains this instance.
id - The instance id.
name - The instance name.
Method Detail

getContainer

public MidiEntity getContainer()
Get the MidiEntity which contains this instance.

Returns:
The MidiEntity which contains this instance.

getID

public int getID()
Get the instance id.

Returns:
The assigned instance id.

getName

public java.lang.String getName()
Get the instance name.

Returns:
The assigned instance name.

setName

public void setName(java.lang.String name)
Set the instance name.

Parameters:
name - The intended instance name.

dispose

public void dispose()
Description copied from class: Disposable
Release resources engaged by this object, thus rendering it amenable to garbage collection.

Specified by:
dispose in class Disposable