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 */
017
018package org.apache.commons.configuration2.spring;
019
020import java.util.ArrayList;
021import java.util.List;
022
023import org.apache.commons.configuration2.Configuration;
024import org.apache.commons.lang3.ArrayUtils;
025import org.springframework.core.env.EnumerablePropertySource;
026
027/**
028 * Allow use of Apache Commons Configuration Objects as Spring PropertySources
029 */
030public class ConfigurationPropertySource extends EnumerablePropertySource<Configuration> {
031
032    /**
033     * Constructs a new instance.
034     *
035     * @param name the associated name.
036     */
037    protected ConfigurationPropertySource(final String name) {
038        super(name);
039    }
040
041    /**
042     * Constructs a new instance.
043     *
044     * @param name   the associated name.
045     * @param source the source object.
046     */
047    public ConfigurationPropertySource(final String name, final Configuration source) {
048        super(name, source);
049    }
050
051    @Override
052    public Object getProperty(final String name) {
053        if (source.getProperty(name) == null) {
054            return null;
055        }
056        final String[] propValue = source.getStringArray(name);
057        if (propValue == null || propValue.length == 0) {
058            return "";
059        }
060        if (propValue.length == 1) {
061            return propValue[0];
062        }
063        return propValue;
064    }
065
066    @Override
067    public String[] getPropertyNames() {
068        final List<String> keys = new ArrayList<>();
069        source.getKeys().forEachRemaining(keys::add);
070        return keys.toArray(ArrayUtils.EMPTY_STRING_ARRAY);
071    }
072}