INIBuilderParametersImpl.java

  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. import java.util.Map;

  19. /**
  20.  * <p>
  21.  * A specialized parameters class for INI configuration.
  22.  * </p>
  23.  * <p>
  24.  * This parameters class defines some properties which allow customizing the parsing and writing of INI documents.
  25.  * </p>
  26.  * <p>
  27.  * This class is not thread-safe. It is intended that an instance is constructed and initialized by a single thread
  28.  * during configuration of a {@code ConfigurationBuilder}.
  29.  * </p>
  30.  *
  31.  * @since 2.2
  32.  */
  33. public class INIBuilderParametersImpl extends HierarchicalBuilderParametersImpl implements INIBuilderProperties<INIBuilderParametersImpl> {
  34.     /** The key for the separatorUsedInINIOutput property. */
  35.     private static final String PROP_SEPARATOR_USED_IN_INI_OUTPUT = "separatorUsedInOutput";

  36.     /** The key for the separatorUsedInInput property. */
  37.     private static final String PROP_SEPARATOR_USED_IN_INI_INPUT = "separatorUsedInInput";

  38.     /** The key for the commentLeadingCharsUsedInInput property. */
  39.     private static final String PROP_COMMENT_LEADING_SEPARATOR_USED_IN_INI_INPUT = "commentLeadingCharsUsedInInput";

  40.     @Override
  41.     public void inheritFrom(final Map<String, ?> source) {
  42.         super.inheritFrom(source);
  43.         copyPropertiesFrom(source, PROP_SEPARATOR_USED_IN_INI_OUTPUT);
  44.         copyPropertiesFrom(source, PROP_SEPARATOR_USED_IN_INI_INPUT);
  45.         copyPropertiesFrom(source, PROP_COMMENT_LEADING_SEPARATOR_USED_IN_INI_INPUT);
  46.     }

  47.     @Override
  48.     public INIBuilderParametersImpl setCommentLeadingCharsUsedInInput(final String separator) {
  49.         storeProperty(PROP_COMMENT_LEADING_SEPARATOR_USED_IN_INI_INPUT, separator);
  50.         return this;
  51.     }

  52.     @Override
  53.     public INIBuilderParametersImpl setSeparatorUsedInInput(final String separator) {
  54.         storeProperty(PROP_SEPARATOR_USED_IN_INI_INPUT, separator);
  55.         return this;
  56.     }

  57.     @Override
  58.     public INIBuilderParametersImpl setSeparatorUsedInOutput(final String separator) {
  59.         storeProperty(PROP_SEPARATOR_USED_IN_INI_OUTPUT, separator);
  60.         return this;
  61.     }
  62. }