HierarchicalBuilderParametersImpl.java

  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. import java.util.Map;

  19. import org.apache.commons.configuration2.tree.ExpressionEngine;

  20. /**
  21.  * <p>
  22.  * A specialized parameters object for hierarchical configurations.
  23.  * </p>
  24.  * <p>
  25.  * This class defines special properties for hierarchical configurations. Because most hierarchical configurations are
  26.  * file-based configurations this class extends {@code FileBasedBuilderParametersImpl}.
  27.  * </p>
  28.  *
  29.  * @since 2.0
  30.  */
  31. public class HierarchicalBuilderParametersImpl extends FileBasedBuilderParametersImpl
  32.     implements HierarchicalBuilderProperties<HierarchicalBuilderParametersImpl> {
  33.     /** Constant for the expression engine property. */
  34.     private static final String PROP_EXPRESSION_ENGINE = "expressionEngine";

  35.     /**
  36.      * {@inheritDoc} This implementation copies some more properties defined by this class.
  37.      */
  38.     @Override
  39.     public void inheritFrom(final Map<String, ?> source) {
  40.         super.inheritFrom(source);
  41.         copyPropertiesFrom(source, PROP_EXPRESSION_ENGINE);
  42.     }

  43.     /**
  44.      * {@inheritDoc} This implementation stores the expression engine in the internal parameters map.
  45.      */
  46.     @Override
  47.     public HierarchicalBuilderParametersImpl setExpressionEngine(final ExpressionEngine engine) {
  48.         storeProperty(PROP_EXPRESSION_ENGINE, engine);
  49.         return this;
  50.     }
  51. }