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

    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;
    018
    019import org.apache.commons.configuration2.tree.ExpressionEngine;
    020
    021/**
    022 * <p>
    023 * Definition of a parameters interface for hierarchical configurations.
    024 * </p>
    025 * <p>
    026 * This interface defines set methods for additional properties common to all hierarchical configurations.
    027 * </p>
    028 * <p>
    029 * <strong>Important note:</strong> This interface is not intended to be implemented by client code! It defines a set of
    030 * available properties and may be extended even in minor releases.
    031 * </p>
    032 *
    033 * @param <T> the type of the result of all set methods for method chaining
    034 * @since 2.0
    035 */
    036public interface HierarchicalBuilderProperties<T> {
    037
    038    /**
    039     * Sets the {@code ExpressionEngine} to be used when querying the configuration.
    040     *
    041     * @param engine the {@code ExpressionEngine}
    042     * @return a reference to this object for method chaining
    043     */
    044    T setExpressionEngine(ExpressionEngine engine);
    045}