KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > pmti > v1 > IEditableAttribute


1 /*
2  * @(#)IEditableAttribute.java
3  *
4  * Copyright (C) 2002-2003 Matt Albrecht
5  * groboclown@users.sourceforge.net
6  * http://groboutils.sourceforge.net
7  *
8  * Part of the GroboUtils package at:
9  * http://groboutils.sourceforge.net
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included in
19  * all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  */
29 package net.sourceforge.groboutils.pmti.v1;
30
31  
32
33 /**
34  * A simple name-value association for a specific kind of issue attribute.
35  * All implementations of <tt>IAttribute</tt> are immutable, unless they also
36  * implement <tt>IEditableAttribute</tt>.
37  *
38  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
39  * @version $Date: 2003/02/10 22:51:54 $
40  * @since July 6, 2002
41  */
42 public interface IEditableAttribute extends IAttribute
43 {
44     /**
45      * @exception IllegalArgumentException thrown if the value argument is
46      * invalid.
47      */
48     public void setValue( Object JavaDoc value );
49     
50     
51     /**
52      * @return <tt>true</tt> if the <tt>setValue( Object )</tt> method has
53      * been called on this instance and the actual value has changed
54      * (via inspection with <tt>==</tt> and <tt>equals()</tt>),
55      * otherwise <tt>false</tt>.
56      */
57     public boolean hasValueChanged();
58     
59     
60     /**
61      * Checks if the given value is a valid input value for the
62      * <tt>setValue( Object )</tt> method.
63      */
64     public boolean isValidValue( Object JavaDoc value );
65 }
66
67
Popular Tags