View Javadoc
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  import java.util.Map;
20  
21  /**
22   * <p>
23   * A specialized parameters class for INI configuration.
24   * </p>
25   * <p>
26   * This parameters class defines some properties which allow customizing the parsing and writing of INI documents.
27   * </p>
28   * <p>
29   * This class is not thread-safe. It is intended that an instance is constructed and initialized by a single thread
30   * during configuration of a {@code ConfigurationBuilder}.
31   * </p>
32   *
33   * @since 2.2
34   */
35  public class INIBuilderParametersImpl extends HierarchicalBuilderParametersImpl implements INIBuilderProperties<INIBuilderParametersImpl> {
36      /** The key for the separatorUsedInINIOutput property. */
37      private static final String PROP_SEPARATOR_USED_IN_INI_OUTPUT = "separatorUsedInOutput";
38  
39      /** The key for the separatorUsedInInput property. */
40      private static final String PROP_SEPARATOR_USED_IN_INI_INPUT = "separatorUsedInInput";
41  
42      /** The key for the commentLeadingCharsUsedInInput property. */
43      private static final String PROP_COMMENT_LEADING_SEPARATOR_USED_IN_INI_INPUT = "commentLeadingCharsUsedInInput";
44  
45      @Override
46      public void inheritFrom(final Map<String, ?> source) {
47          super.inheritFrom(source);
48          copyPropertiesFrom(source, PROP_SEPARATOR_USED_IN_INI_OUTPUT);
49          copyPropertiesFrom(source, PROP_SEPARATOR_USED_IN_INI_INPUT);
50          copyPropertiesFrom(source, PROP_COMMENT_LEADING_SEPARATOR_USED_IN_INI_INPUT);
51      }
52  
53      @Override
54      public INIBuilderParametersImpl setSeparatorUsedInOutput(final String separator) {
55          storeProperty(PROP_SEPARATOR_USED_IN_INI_OUTPUT, separator);
56          return this;
57      }
58  
59      @Override
60      public INIBuilderParametersImpl setSeparatorUsedInInput(final String separator) {
61          storeProperty(PROP_SEPARATOR_USED_IN_INI_INPUT, separator);
62          return this;
63      }
64  
65      @Override
66      public INIBuilderParametersImpl setCommentLeadingCharsUsedInInput(final String separator) {
67          storeProperty(PROP_COMMENT_LEADING_SEPARATOR_USED_IN_INI_INPUT, separator);
68          return this;
69      }
70  }