Source code: jmx/util/ReadListener.java
1 /*
2 * ReadListener.java 0.1.1.0 20th February 2001
3 *
4 * Copyright (C) 2000 Adam Kirby
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 *
15 * See the GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 */
21
22 package jmx.util;
23
24 import jm.music.data.Score;
25
26 /**
27 * The listener interface for receiving notification of scores being
28 * successfully imported from a file.
29 *
30 * @author Adam Kirby
31 * @version 1.0,Sun Feb 25 18:35:35 2001
32 */
33 public interface ReadListener {
34 /**
35 * Implementations of this method have the opportunity to alter the score
36 * after each has been imported. Additionally non-score related tasks can
37 * be performed.
38 *
39 * @param score Score imported by the object initiating this event
40 * @return updated score to send back to the initiating object
41 */
42 public Score scoreRead(final Score score);
43
44 /** YET TO BE DOCUMENTED */
45 public void startedReading();
46
47 /**
48 * Implementations of this method can alter all the scores imported by the
49 * initiating object. Additionally non-score related tasks can be
50 * performed.
51 *
52 * @param scores all Scores imported by the object initiating this event
53 * @return updated scores to send back to the initiating object
54 */
55 public void finishedReading();
56 }