    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
    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
    027 * hierarchical configurations.
    028 * </p>
    029 * <p>
    030 * <strong>Important note:</strong> This interface is not intended to be
    031 * implemented by client code! It defines a set of available properties and may
    032 * be extended even in minor releases.
    033 * </p>
    034 *
    035 * @version $Id: HierarchicalBuilderProperties.java 1624757 2014-09-13 15:47:43Z oheger $
    036 * @since 2.0
    037 * @param <T> the type of the result of all set methods for method chaining
    038 */
    039public interface HierarchicalBuilderProperties<T>
    040{
    041    /**
    042     * Sets the {@code ExpressionEngine} to be used when querying the
    043     * configuration.
    044     *
    045     * @param engine the {@code ExpressionEngine}
    046     * @return a reference to this object for method chaining
    047     */
    048    T setExpressionEngine(ExpressionEngine engine);
    049}