jm.midi.event.Event Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jmusic Show documentation

JMusic - Java Music Library

The newest version!

/*

:48  2001

Copyright (C) 2000 Andrew Sorensen & Andrew Brown

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or any
later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

package jm.midi.event;

import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;

/**
 * ***********************************************************
 * The Event interface is the public interface for ALL MIDI event
 * classes.
 *
 * @author Andrew Sorensen
 *         *************************************************************
 */

public interface Event {
    /**
     * Retrieve an events time
     */
    public int getTime();

    /**
     * Set an events time
     */
    public void setTime(int time);

    /**
     * Retrieve an events id
     */
    public short getID();

    /**
     * Makes a copy of an event
     */
    public Event copy() throws CloneNotSupportedException;

    /**
     * Print this events data in a System.out.println format
     */
    public void print();

    /**
     * write out event data to disk
     */
    public int write(DataOutputStream dos) throws IOException;

    /**
     * read in event data from disk
     */
    public int read(DataInputStream dis) throws IOException;
}