View Javadoc
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.spring;
19  
20  import java.util.ArrayList;
21  import java.util.List;
22  
23  import org.apache.commons.configuration2.Configuration;
24  import org.apache.commons.lang3.ArrayUtils;
25  import org.springframework.core.env.EnumerablePropertySource;
26  
27  /**
28   * Allow use of Apache Commons Configuration Objects as Spring PropertySources
29   */
30  public class ConfigurationPropertySource extends EnumerablePropertySource<Configuration> {
31  
32      /**
33       * Constructs a new instance.
34       *
35       * @param name the associated name.
36       */
37      protected ConfigurationPropertySource(final String name) {
38          super(name);
39      }
40  
41      /**
42       * Constructs a new instance.
43       *
44       * @param name   the associated name.
45       * @param source the source object.
46       */
47      public ConfigurationPropertySource(final String name, final Configuration source) {
48          super(name, source);
49      }
50  
51      @Override
52      public Object getProperty(final String name) {
53          if (source.getProperty(name) == null) {
54              return null;
55          }
56          final String[] propValue = source.getStringArray(name);
57          if (propValue == null || propValue.length == 0) {
58              return "";
59          }
60          if (propValue.length == 1) {
61              return propValue[0];
62          }
63          return propValue;
64      }
65  
66      @Override
67      public String[] getPropertyNames() {
68          final List<String> keys = new ArrayList<>();
69          source.getKeys().forEachRemaining(keys::add);
70          return keys.toArray(ArrayUtils.EMPTY_STRING_ARRAY);
71      }
72  }