1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.configuration2.builder;
18
19 /**
20 * <p>
21 * Definition of a parameters interface for INI configurations.
22 * </p>
23 * <p>
24 * The {@code INIConfiguration} class defines a bunch of additional properties related to INI processing.
25 * </p>
26 * <p>
27 * <strong>Important note:</strong> This interface is not intended to be implemented by client code! It defines a set of
28 * available properties and may be extended even in minor releases.
29 * </p>
30 *
31 * @since 2.2
32 * @param <T> the type of the result of all set methods for method chaining
33 */
34 public interface INIBuilderProperties<T> {
35
36 /**
37 * Allows setting the leading comment separator which is used in reading an INI file.
38 *
39 * @param separator String of the new separator for INI reading
40 * @return a reference to this object for method chaining
41 * @since 2.5
42 */
43 default T setCommentLeadingCharsUsedInInput(final String separator) {
44 // NoOp
45 return (T) this;
46 }
47
48 /**
49 * Allows setting the key and value separator which is used in reading an INI file.
50 *
51 * @param separator String of the new separator for INI reading
52 * @return a reference to this object for method chaining
53 * @since 2.5
54 */
55 default T setSeparatorUsedInInput(final String separator) {
56 // NoOp
57 return (T) this;
58 }
59
60 /**
61 * Allows setting the separator between key and value to be used when writing an INI file.
62 *
63 * @param separator the new separator for INI output
64 * @return a reference to this object for method chaining
65 */
66 T setSeparatorUsedInOutput(String separator);
67 }