src/share/classes/javax/sound/midi/MidiEvent.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 1999, 2002, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
@@ -24,43 +24,37 @@
*/
package javax.sound.midi;
/**
- * MIDI events contain a MIDI message and a corresponding time-stamp
- * expressed in ticks, and can represent the MIDI event information
- * stored in a MIDI file or a <code>{@link Sequence}</code> object. The
- * duration of a tick is specified by the timing information contained
- * in the MIDI file or <code>Sequence</code> object.
+ * MIDI events contain a MIDI message and a corresponding time-stamp expressed
+ * in ticks, and can represent the MIDI event information stored in a MIDI file
+ * or a {@link Sequence} object. The duration of a tick is specified by the
+ * timing information contained in the MIDI file or {@code Sequence} object.
* <p>
- * In Java Sound, <code>MidiEvent</code> objects are typically contained in a
- * <code>{@link Track}</code>, and <code>Tracks</code> are likewise
- * contained in a <code>Sequence</code>.
- *
+ * In Java Sound, {@code MidiEvent} objects are typically contained in a
+ * {@link Track}, and {@code Tracks} are likewise contained in a
+ * {@code Sequence}.
*
* @author David Rivas
* @author Kara Kytle
*/
public class MidiEvent {
-
- // Instance variables
-
/**
* The MIDI message for this event.
*/
private final MidiMessage message;
-
/**
* The tick value for this event.
*/
private long tick;
-
/**
- * Constructs a new <code>MidiEvent</code>.
+ * Constructs a new {@code MidiEvent}.
+ *
* @param message the MIDI message contained in the event
* @param tick the time-stamp for the event, in MIDI ticks
*/
public MidiEvent(MidiMessage message, long tick) {
@@ -68,28 +62,29 @@
this.tick = tick;
}
/**
* Obtains the MIDI message contained in the event.
+ *
* @return the MIDI message
*/
public MidiMessage getMessage() {
return message;
}
-
/**
- * Sets the time-stamp for the event, in MIDI ticks
+ * Sets the time-stamp for the event, in MIDI ticks.
+ *
* @param tick the new time-stamp, in MIDI ticks
*/
public void setTick(long tick) {
this.tick = tick;
}
-
/**
- * Obtains the time-stamp for the event, in MIDI ticks
+ * Obtains the time-stamp for the event, in MIDI ticks.
+ *
* @return the time-stamp for the event, in MIDI ticks
*/
public long getTick() {
return tick;
}