Dead
[official-gcc.git] / gomp-20050608-branch / libjava / classpath / javax / sound / midi / Track.java
blobda7ef2ef3b962c0467199091655a1d50387b9907
1 /* Track.java -- A track of MIDI events
2 Copyright (C) 2005 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
39 package javax.sound.midi;
41 import java.util.HashSet;
42 import java.util.Vector;
44 /**
45 * A Track contains a list of timecoded MIDI events for processing
46 * by a Sequencer.
48 * @author Anthony Green (green@redhat.com)
49 * @since 1.3
52 public class Track
54 /**
55 * The list of MidiEvents for this track.
57 protected Vector events;
59 // A HashSet to speed processing
60 private HashSet eventSet;
62 /**
63 * Add a new event to this track. Specific events may only be added once.
64 * The event will be inserted into the appropriate spot in the event list
65 * based on its timecode.
67 * @param event the event to add
68 * @return true if the event was added, false otherwise
70 public boolean add(MidiEvent event)
72 synchronized (events)
74 if (eventSet.contains(event))
75 return false;
77 eventSet.add(event);
79 long targetTick = event.getTick();
80 int i = events.size() - 1;
81 while (i >= 0 && (((MidiEvent)events.get(i)).getTick() > targetTick))
82 i--;
83 events.add(i+1, event);
84 return true;
88 /**
89 * Remove an event from this track.
91 * @param event the event to remove
92 * @return true if the event was removed, false otherwise
94 public boolean remove(MidiEvent event)
96 synchronized (events)
98 if (! eventSet.remove(event))
99 return false;
101 int i = events.indexOf(event);
102 if (i >= 0)
104 events.remove(i);
105 return true;
108 throw new InternalError("event in set but not list");
113 * Get an event idetified by its order index
115 * @param index the location of the event to get
116 * @return the event at index
117 * @throws ArrayIndexOutOfBoundsException if index is out of bounds
119 public MidiEvent get(int index) throws ArrayIndexOutOfBoundsException
121 synchronized (events)
125 return (MidiEvent) events.get(index);
127 catch (IndexOutOfBoundsException e)
129 throw (ArrayIndexOutOfBoundsException)
130 new ArrayIndexOutOfBoundsException().initCause(e);
137 * Get the number events in this track.
139 * @return the number of events in this track
141 public int size()
143 return events.size();
147 * Get the length of the track in MIDI ticks.
149 * @return the length of the track in MIDI ticks
151 public long ticks()
153 synchronized (events)
155 int size = events.size();
156 return ((MidiEvent) events.get(size - 1)).getTick();