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 java.util.Map;
020
021import org.apache.commons.configuration2.ConfigurationConsumer;
022import org.apache.commons.configuration2.PropertiesConfiguration.IOFactory;
023import org.apache.commons.configuration2.PropertiesConfigurationLayout;
024import org.apache.commons.configuration2.ex.ConfigurationException;
025
026/**
027 * <p>
028 * A specialized parameter class for configuring {@code PropertiesConfiguration} instances.
029 * </p>
030 * <p>
031 * This class allows setting of some properties specific to properties configuration, e.g. the layout object. By
032 * inheriting from {@link FileBasedBuilderParametersImpl}, basic properties and properties related to file-based
033 * configurations are available, too.
034 * </p>
035 * <p>
036 * This class is not thread-safe. It is intended that an instance is constructed and initialized by a single thread
037 * during configuration of a {@code ConfigurationBuilder}.
038 * </p>
039 *
040 * @since 2.0
041 */
042public class PropertiesBuilderParametersImpl extends FileBasedBuilderParametersImpl implements PropertiesBuilderProperties<PropertiesBuilderParametersImpl> {
043    /** The key for the include listener property. */
044    private static final String PROP_INCLUDE_LISTENER = "includeListener";
045
046    /** The key for the includes allowed property. */
047    private static final String PROP_INCLUDES_ALLOWED = "includesAllowed";
048
049    /** The key for the layout property. */
050    private static final String PROP_LAYOUT = "layout";
051
052    /** The key for the IO factory property. */
053    private static final String PROP_IO_FACTORY = "IOFactory";
054
055    @Override
056    public PropertiesBuilderParametersImpl setIncludeListener(final ConfigurationConsumer<ConfigurationException> includeListener) {
057        storeProperty(PROP_INCLUDE_LISTENER, includeListener);
058        return this;
059    }
060
061    @Override
062    public PropertiesBuilderParametersImpl setIncludesAllowed(final boolean f) {
063        storeProperty(PROP_INCLUDES_ALLOWED, Boolean.valueOf(f));
064        return this;
065    }
066
067    /**
068     * {@inheritDoc} This implementation takes some more properties into account that are defined in this class.
069     */
070    @Override
071    public void inheritFrom(final Map<String, ?> source) {
072        super.inheritFrom(source);
073        copyPropertiesFrom(source, PROP_INCLUDES_ALLOWED, PROP_INCLUDE_LISTENER, PROP_IO_FACTORY);
074    }
075
076    @Override
077    public PropertiesBuilderParametersImpl setLayout(final PropertiesConfigurationLayout layout) {
078        storeProperty(PROP_LAYOUT, layout);
079        return this;
080    }
081
082    @Override
083    public PropertiesBuilderParametersImpl setIOFactory(final IOFactory factory) {
084        storeProperty(PROP_IO_FACTORY, factory);
085        return this;
086    }
087}