KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > app > update > ClientComponentUpdate


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.app.update;
31
32 import java.io.Serializable JavaDoc;
33 import java.util.Collections JavaDoc;
34 import java.util.HashMap JavaDoc;
35 import java.util.Iterator JavaDoc;
36 import java.util.Map JavaDoc;
37
38 import nextapp.echo2.app.Component;
39
40 /**
41  * A representation of all updates made on the client to an individual
42  * component.
43  */
44 public class ClientComponentUpdate
45 implements Serializable JavaDoc {
46         
47     private Component component;
48     private Map JavaDoc inputs;
49     
50     /**
51      * Creates a <code>ClientComponentUpdate</code>.
52      *
53      * @param component the updated component
54      */
55     ClientComponentUpdate(Component component) {
56         super();
57         this.component = component;
58         inputs = new HashMap JavaDoc();
59     }
60     
61     /**
62      * Adds an input property to the update, describing a single change
63      * to the component's client-side state.
64      *
65      * @param inputName the name of the input property
66      * @param inputValue the new state of the property
67      */
68     public void addInput(String JavaDoc inputName, Object JavaDoc inputValue) {
69         inputs.put(inputName, inputValue);
70     }
71
72     /**
73      * Returns the updated component.
74      *
75      * @return the component
76      */
77     public Component getComponent() {
78         return component;
79     }
80     
81     /**
82      * Returns an iterator over the names of all input properties.
83      *
84      * @return the <code>Iterator</code>
85      */
86     public Iterator JavaDoc getInputNames() {
87         return Collections.unmodifiableSet(inputs.keySet()).iterator();
88     }
89
90     /**
91      * Retrieves the new state of the specified input property.
92      *
93      * @param inputName the name of the input property
94      * @return the new state
95      */
96     public Object JavaDoc getInputValue(String JavaDoc inputName) {
97         return inputs.get(inputName);
98     }
99     
100     /**
101      * Determines if an input was posted with the specified property name.
102      *
103      * @param inputName the input property name
104      * @return true if an input is posted
105      */
106     public boolean hasInput(String JavaDoc inputName) {
107         return inputs.containsKey(inputName);
108     }
109 }
110
Popular Tags