KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > springframework > binding > collection > SharedMap


1 /*
2  * Copyright 2002-2006 the original author or authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.springframework.binding.collection;
17
18 import java.util.Map JavaDoc;
19
20 /**
21  * A simple subinterface of {@link Map} that exposes a mutex that
22  * application code can synchronize on.
23  * <p>
24  * Expected to be implemented by Maps that are backed by shared objects that
25  * require synchronization between multiple threads. An example would be the
26  * HTTP session map.
27  *
28  * @author Keith Donald
29  */
30 public interface SharedMap extends Map JavaDoc {
31
32     /**
33      * Returns the shared mutex that may be synchronized on using a
34      * synchronized block. The returned mutex is guaranteed to be non-null.
35      *
36      * Example usage:
37      *
38      * <pre>
39      * synchronized (sharedMap.getMutex()) {
40      * // do synchronized work
41      * }
42      * </pre>
43      *
44      * @return the mutex
45      */
46     public Object JavaDoc getMutex();
47 }
Popular Tags