Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ConfigurableCustomConverter |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright 2005-2013 Dozer Project | |
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.dozer; | |
17 | ||
18 | ||
19 | /** | |
20 | * Public custom converter interface. | |
21 | * | |
22 | * In the Dozer mapping file(s), you can add some XML to tell Dozer to use a custom converter for certain class A and | |
23 | * class B types. When a custom converter is specified for a class A and class B combination, Dozer will invoke the | |
24 | * custom converter to perform the data mapping instead of the standard mapping logic. | |
25 | * | |
26 | * This interface also gives you the opportunity to send a configuration parameter to it | |
27 | * <p> | |
28 | * <a | |
29 | * href="http://dozer.sourceforge.net/documentation/customconverter.html">http://dozer.sourceforge.net/documentation/customconverter.html</a> | |
30 | * | |
31 | * | |
32 | * @author johnsen.knut-erik | |
33 | * | |
34 | */ | |
35 | public interface ConfigurableCustomConverter extends CustomConverter { | |
36 | ||
37 | /** | |
38 | * Setter for converter static parameter. Method is guaranteed to be called before the first execution. | |
39 | * | |
40 | * @param parameter - converter instance, which is injected via custom-converter-param attribute | |
41 | */ | |
42 | void setParameter(String parameter); | |
43 | ||
44 | ||
45 | } |