    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *     http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.configuration2.builder;
    018
    019/**
    020 * <p>
    021 * Definition of a parameters interface for INI configurations.
    022 * </p>
    023 * <p>
    024 * The {@code INIConfiguration} class defines a bunch of additional properties
    025 * related to INI processing.
    026 * </p>
    027 * <p>
    028 * <strong>Important note:</strong> This interface is not intended to be
    029 * implemented by client code! It defines a set of available properties and may
    030 * be extended even in minor releases.
    031 * </p>
    032 *
    033 * @since 2.2
    034 * @param <T> the type of the result of all set methods for method chaining
    035 */
    036public interface INIBuilderProperties<T>
    037{
    038
    039    /**
    040     * Allows setting the leading comment separator which is used in reading an INI
    041     * file.
    042     *
    043     * @param separator String of the new separator for INI reading
    044     * @return a reference to this object for method chaining
    045     * @since 2.5
    046     */
    047    default T setCommentLeadingCharsUsedInInput(final String separator)
    048    {
    049        // NoOp
    050        return (T) this;
    051    }
    052
    053    /**
    054     * Allows setting the key and value separator which is used in reading an INI
    055     * file.
    056     *
    057     * @param separator String of the new separator for INI reading
    058     * @return a reference to this object for method chaining
    059     * @since 2.5
    060     */
    061    default T setSeparatorUsedInInput(final String separator)
    062    {
    063        // NoOp
    064        return (T) this;
    065    }
    066
    067    /**
    068     * Allows setting the separator between key and value to be used when writing an
    069     * INI file.
    070     *
    071     * @param separator the new separator for INI output
    072     * @return a reference to this object for method chaining
    073     */
    074    T setSeparatorUsedInOutput(String separator);
    075}