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