KickJava   Java API By Example, From Geeks To Geeks.

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


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  * An object whose contents are capable of being exposed as an unmodifiable map.
22  * @author Keith Donald
23  */
24 public interface MapAdaptable {
25
26     /**
27      * Returns this object's contents as a {@link Map}. The returned map may or
28      * may not be modifiable depending on this implementation.
29      * <p>
30      * Warning: this operation may be called frequently; if so care should be
31      * taken so that the map contents (if calculated) be cached as appropriate.
32      * @return the object's contents as a map.
33      */
34     public Map JavaDoc asMap();
35
36 }
Popular Tags