jdk/src/java.desktop/share/classes/javax/sound/midi/MidiEvent.java
author ddehaven
Tue, 19 Aug 2014 10:32:16 -0700
changeset 26037 508779ce6619
parent 26003 jdk/src/share/classes/javax/sound/midi/MidiEvent.java@d630c97424bd
parent 25859 jdk/src/share/classes/javax/sound/midi/MidiEvent.java@3317bb8137f4
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
     2
 * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.sound.midi;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    29
 * MIDI events contain a MIDI message and a corresponding time-stamp expressed
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    30
 * in ticks, and can represent the MIDI event information stored in a MIDI file
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    31
 * or a {@link Sequence} object. The duration of a tick is specified by the
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    32
 * timing information contained in the MIDI file or {@code Sequence} object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * <p>
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    34
 * In Java Sound, {@code MidiEvent} objects are typically contained in a
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    35
 * {@link Track}, and {@code Tracks} are likewise contained in a
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    36
 * {@code Sequence}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * @author David Rivas
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * @author Kara Kytle
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
public class MidiEvent {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
     * The MIDI message for this event.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
    private final MidiMessage message;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * The tick value for this event.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    private long tick;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    /**
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    54
     * Constructs a new {@code MidiEvent}.
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    55
     *
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    56
     * @param  message the MIDI message contained in the event
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    57
     * @param  tick the time-stamp for the event, in MIDI ticks
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public MidiEvent(MidiMessage message, long tick) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
        this.message = message;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
        this.tick = tick;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * Obtains the MIDI message contained in the event.
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    67
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * @return the MIDI message
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    public MidiMessage getMessage() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
        return message;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    /**
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    75
     * Sets the time-stamp for the event, in MIDI ticks.
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    76
     *
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    77
     * @param  tick the new time-stamp, in MIDI ticks
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    public void setTick(long tick) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
        this.tick = tick;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    /**
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    84
     * Obtains the time-stamp for the event, in MIDI ticks.
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 5506
diff changeset
    85
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * @return the time-stamp for the event, in MIDI ticks
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    public long getTick() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
        return tick;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
}