Source code: com/clra/util/INamed.java
1 /*
2 * Copyright (c) Carnegie Lake Rowing Association 2002. All rights reserved.
3 * Distributed under the GPL license. See doc/COPYING.
4 * $RCSfile: INamed.java,v $
5 * $Date: 2003/02/26 03:38:45 $
6 * $Revision: 1.3 $
7 */
8
9 package com.clra.util;
10
11 /**
12 * Declares a read-only interface for named objects.
13 * Named objects should guarantee that <tt>getName()</tt> returns a
14 * non-null and non-blank value (otherwise it doesn't make much sense
15 * to declare an object as 'Named'). Implementations should also trim
16 * names (i.e. remove leading and trailing whitespace) since whitespace
17 * doesn't make much sense in a name.
18 *
19 * @version $Revision: 1.3 $ $Date: 2003/02/26 03:38:45 $
20 * @author <a href="mailto:rphall@pluto.njcc.com">Rick Hall</a>
21 */
22 public interface INamed {
23
24 /**
25 * Returns the name of an object.
26 * @return a non-null, non-blank, trimmed value.
27 * much sense to declare an object as 'named').
28 */
29 public String getName();
30
31 } // INamed
32
33 /*
34 * $Log: INamed.java,v $
35 * Revision 1.3 2003/02/26 03:38:45 rphall
36 * Added copyright and GPL license
37 *
38 * Revision 1.2 2002/02/18 18:05:26 rphall
39 * Ran dos2unix to remove ^M (carriage return) from end of lines
40 *
41 * Revision 1.1.1.1 2002/01/03 21:57:28 rphall
42 * Initial load, 5th try, Jan-03-2002 4:57 PM
43 *
44 * Revision 1.1 2001/12/31 16:11:32 rphall
45 * *** empty log message ***
46 *
47 */
48