Source code: com/virtuosotechnologies/asaph/model/SimpleString.java
1 /*
2 ================================================================================
3
4 FILE: SimpleString.java
5
6 PROJECT:
7
8 Asaph
9
10 CONTENTS:
11
12 Interface to a simple string object
13
14 PROGRAMMERS:
15
16 Daniel Azuma (DA) <dazuma@kagi.com>
17
18 COPYRIGHT:
19
20 Copyright (C) 2003 Daniel Azuma (dazuma@kagi.com)
21
22 This program is free software; you can redistribute it and/or
23 modify it under the terms of the GNU General Public License as
24 published by the Free Software Foundation; either version 2
25 of the License, or (at your option) any later version.
26
27 This program is distributed in the hope that it will be useful,
28 but WITHOUT ANY WARRANTY; without even the implied warranty of
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 GNU General Public License for more details.
31
32 You should have received a copy of the GNU General Public
33 License along with this program; if not, write to
34 Free Software Foundation, Inc.
35 59 Temple Place, Suite 330
36 Boston, MA 02111-1307 USA
37
38 ================================================================================
39 */
40
41
42 package com.virtuosotechnologies.asaph.model;
43
44 import javax.swing.event.UndoableEditListener;
45
46
47 /**
48 * Interface to a simple string object.
49 */
50 public interface SimpleString
51 extends SongMember
52 {
53 //-------------------------------------------------------------------------
54 // Accessor methods
55 //-------------------------------------------------------------------------
56
57 /**
58 * Get the string value. The value could be the empty string but will
59 * never be null.
60 *
61 * @return String
62 */
63 public String getString();
64
65
66 //-------------------------------------------------------------------------
67 // Mutation methods
68 //-------------------------------------------------------------------------
69
70 /**
71 * Set the string value. You may not set the value to null.
72 *
73 * @param str new string value
74 * @param undoListener listener to notify if an undoable edit is generated,
75 * or null to suppress generation of undoable edits
76 * @exception NullPointerException str was null
77 */
78 public void setString(
79 String str,
80 UndoableEditListener undoListener);
81 }