1 /*
2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
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 de.smartics.properties.spi.core.convert;
17
18 import java.io.Serializable;
19
20 import de.smartics.properties.api.core.domain.PropertyDescriptor;
21 import de.smartics.properties.api.core.domain.PropertyValueConversionException;
22
23 /**
24 * Converter of property values to and from Strings.
25 */
26 public interface PropertyValueConverter extends Serializable
27 {
28 // ********************************* Fields *********************************
29
30 // --- constants ------------------------------------------------------------
31
32 // ****************************** Initializer *******************************
33
34 // ****************************** Inner Classes *****************************
35
36 // ********************************* Methods ********************************
37
38 // --- get&set --------------------------------------------------------------
39
40 // --- business -------------------------------------------------------------
41
42 /**
43 * Converts, if necessary, the given value to the target type defined by the
44 * {@code descriptor}.
45 *
46 * @param descriptor the descriptor of the property.
47 * @param value the value to be converted according to the rules defined by
48 * the {@code descriptor}.
49 * @return the converted value.
50 * @throws PropertyValueConversionException if the value cannot be converted
51 * from {@link String} to the target type.
52 */
53 Object convert(PropertyDescriptor descriptor, Object value)
54 throws PropertyValueConversionException;
55
56 // --- object basics --------------------------------------------------------
57 }