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.model22.other;
23:
24: import java.util.Set;
25:
26: /**
27: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
28: * @version $Revision: 8784 $
29: */
30: public interface ValueMap {
31: /** Return the key set of the map. */
32: Set getKeys();
33:
34: /**
35: * Return the value for the given key or null if it does not exist.
36: *
37: * @param key the requested key
38: * @return the requested value or null if it does not exist
39: * @throws IllegalArgumentException if the key is null
40: */
41: Value getValue(String key) throws IllegalArgumentException;
42:
43: /**
44: * Update the value of the given key. If the value object is null it means that the entry must be removed.
45: * Implementation can throw an unsupported operation exception when it is abnormal to perform an update.
46: *
47: * @param key the key to update
48: * @param value the new value
49: * @throws UnsupportedOperationException if the operation is not supported
50: * @throws IllegalArgumentException if the key is null
51: */
52: void setValue(String key, Value value)
53: throws IllegalArgumentException,
54: UnsupportedOperationException;
55: }
|