01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.migration.model20.model;
23:
24: import org.jboss.portal.migration.model20.other.Value;
25:
26: import java.util.Set;
27:
28: /**
29: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
30: * @version $Revision: 8784 $
31: */
32: public interface PreferenceSet {
33: /** Return the key set of all the preferences. */
34: Set keySet();
35:
36: /**
37: * Return the preference for the given key. If no preference exists it must return null.
38: *
39: * @param key the requested key
40: * @return the requested preference or null if it does not exist
41: */
42: Preference getPreference(String key);
43:
44: /**
45: * Return the value for the given key or null if it does not exist.
46: *
47: * @param key the requested key
48: * @return the requested value or null if it does not exist
49: */
50: Value getValue(String key);
51:
52: /**
53: * Update the value of the given key. If the value object is null it means that the preference must be removed.
54: * Implementation can throw an unsupported operation exception when it is abnormal to perform an update.
55: *
56: * @param key the key to update
57: * @param value the new value
58: * @throws UnsupportedOperationException if the operation is not supported
59: */
60: void setValue(String key, Value value)
61: throws UnsupportedOperationException;
62:
63: /**
64: * Return the read only value for the given preference.
65: *
66: * @param key the requested key
67: * @return the read only value
68: */
69: boolean isReadOnly(String key);
70:
71: /**
72: * Update the read only value for the given key. Implementation can throw an unsupported operation exception when it
73: * is abnormal to perform an update.
74: *
75: * @param key the key to update
76: * @param readOnly the new read only value
77: * @throws UnsupportedOperationException if the operation is not supported
78: */
79: void setReadOnly(String key, boolean readOnly)
80: throws UnsupportedOperationException;
81: }
|