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 * https://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
18 package org.apache.commons.configuration2.builder;
19
20 import java.util.Map;
21
22 import org.apache.commons.configuration2.tree.ExpressionEngine;
23
24 /**
25 * A specialized parameters object for hierarchical configurations.
26 * <p>
27 * This class defines special properties for hierarchical configurations. Because most hierarchical configurations are file-based configurations this class
28 * extends {@code FileBasedBuilderParametersImpl}.
29 * </p>
30 *
31 * @since 2.0
32 */
33 public class HierarchicalBuilderParametersImpl extends FileBasedBuilderParametersImpl
34 implements HierarchicalBuilderProperties<HierarchicalBuilderParametersImpl> {
35
36 /** Constant for the expression engine property. */
37 private static final String PROP_EXPRESSION_ENGINE = "expressionEngine";
38
39 /**
40 * Constructs a new instance.
41 */
42 public HierarchicalBuilderParametersImpl() {
43 // empty
44 }
45
46 /**
47 * {@inheritDoc} This implementation copies some more properties defined by this class.
48 */
49 @Override
50 public void inheritFrom(final Map<String, ?> source) {
51 super.inheritFrom(source);
52 copyPropertiesFrom(source, PROP_EXPRESSION_ENGINE);
53 }
54
55 /**
56 * {@inheritDoc} This implementation stores the expression engine in the internal parameters map.
57 */
58 @Override
59 public HierarchicalBuilderParametersImpl setExpressionEngine(final ExpressionEngine engine) {
60 storeProperty(PROP_EXPRESSION_ENGINE, engine);
61 return this;
62 }
63 }