1 /*
2 * Copyright 2001-2013 Stephen Colebourne
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.joda.beans;
17
18 import java.util.Map;
19
20 /**
21 * A map of properties that is linked to a specific bean.
22 * <p>
23 * For a JavaBean, this will ultimately wrap get/set method pairs.
24 * Alternate implementations may perform any logic to obtain the value.
25 *
26 * @author Stephen Colebourne
27 */
28 public interface PropertyMap extends Map<String, Property<?>> {
29
30 /**
31 * Flattens the contents of this property map to a {@code Map}.
32 * <p>
33 * The returned map will contain all the properties from the bean with their actual values.
34 *
35 * @return the unmodifiable map of property name to value, not null
36 */
37 Map<String, Object> flatten();
38
39 }