Source code
Description: source: package: org.apache.commons.configuration2.builder.combined, interface: MultiFileBuilderProperties

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