1 /*
2 * Copyright 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.config.transfer.templatestream;
17
18 /**
19 * Escapes config key, property name and value.
20 */
21 public interface ValueEscaper
22 {
23 // ********************************* Fields *********************************
24
25 // --- constants ------------------------------------------------------------
26
27 // ****************************** Initializer *******************************
28
29 // ****************************** Inner Classes *****************************
30
31 // ********************************* Methods ********************************
32
33 // --- get&set --------------------------------------------------------------
34
35 // --- business -------------------------------------------------------------
36
37 /**
38 * Escapes the given config key.
39 *
40 * @param value the value to escape. May be <code>null</code>.
41 * @return the escaped value.
42 */
43 String escapeConfigKey(String value);
44
45 /**
46 * Escapes the given property name.
47 *
48 * @param value the value to escape. May be <code>null</code>.
49 * @return the escaped value.
50 */
51 String escapeName(String value);
52
53 /**
54 * Escapes the given value.
55 *
56 * @param value the value to escape. May be <code>null</code>.
57 * @return the escaped value.
58 */
59 String escapeValue(String value);
60
61 // --- object basics --------------------------------------------------------
62
63 }