View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.configuration2.builder;
18  
19  import java.util.Map;
20  
21  import org.apache.commons.configuration2.tree.ExpressionEngine;
22  
23  /**
24   * <p>
25   * A specialized parameters object for hierarchical configurations.
26   * </p>
27   * <p>
28   * This class defines special properties for hierarchical configurations. Because most hierarchical configurations are
29   * file-based configurations this class extends {@code FileBasedBuilderParametersImpl}.
30   * </p>
31   *
32   * @since 2.0
33   */
34  public class HierarchicalBuilderParametersImpl extends FileBasedBuilderParametersImpl
35      implements HierarchicalBuilderProperties<HierarchicalBuilderParametersImpl> {
36      /** Constant for the expression engine property. */
37      private static final String PROP_EXPRESSION_ENGINE = "expressionEngine";
38  
39      /**
40       * {@inheritDoc} This implementation copies some more properties defined by this class.
41       */
42      @Override
43      public void inheritFrom(final Map<String, ?> source) {
44          super.inheritFrom(source);
45          copyPropertiesFrom(source, PROP_EXPRESSION_ENGINE);
46      }
47  
48      /**
49       * {@inheritDoc} This implementation stores the expression engine in the internal parameters map.
50       */
51      @Override
52      public HierarchicalBuilderParametersImpl setExpressionEngine(final ExpressionEngine engine) {
53          storeProperty(PROP_EXPRESSION_ENGINE, engine);
54          return this;
55      }
56  }