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.combined;
018
019import org.apache.commons.configuration2.builder.BuilderParameters;
020
021/**
022 * <p>
023 * Definition of a properties interface for the parameters of a multiple file
024 * configuration builder.
025 * </p>
026 * <p>
027 * This interface defines a number of properties for configuring a builder
028 * managing multiple file-based configurations which are selected by a pattern.
029 * Properties can be set in a fluent style.
030 * </p>
031 * <p>
032 * <strong>Important note:</strong> This interface is not intended to be
033 * implemented by client code! It defines a set of available properties and may
034 * be extended even in minor releases.
035 * </p>
036 *
037 * @version $Id $
038 * @since 2.0
039 * @param <T> the return type of all methods for allowing method chaining
040 */
041public interface MultiFileBuilderProperties<T>
042{
043    /**
044     * Sets the pattern string. Based on this pattern the configuration file to
045     * be loaded is determined.
046     *
047     * @param p the pattern string
048     * @return a reference to this object for method chaining
049     */
050    T setFilePattern(String p);
051
052    /**
053     * Sets a parameters object to be used when creating a managed
054     * configuration. These parameters configure sub configurations.
055     *
056     * @param p the parameters object for a sub configuration
057     * @return a reference to this object for method chaining
058     */
059    T setManagedBuilderParameters(BuilderParameters p);
060}