1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.configuration

File ConfigurationSource.java

 

Code metrics

0
0
0
1
80
13
0
-
-
0
-

Classes

Class Line # Actions
ConfigurationSource 31 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.configuration;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * @version $Id: 38a8e3b73c6cb020361eee4374c197ed9f9d10e8 $
28    * @since 1.6M1
29    */
30    @Role
 
31    public interface ConfigurationSource
32    {
33    /**
34    * @param <T> the value type
35    * @param key the property key for which we want the value
36    * @param defaultValue the value to use if the key isn't found
37    * @return the property value is found or the default value if the key wasn't found
38    * @since 2.0M1
39    */
40    <T> T getProperty(String key, T defaultValue);
41   
42    /**
43    * @param <T> the value type
44    * @param key the property key for which we want the value
45    * @param valueClass the type of object that should be returned. The value is converted to the passed type.
46    * @return the property value is found. If the key wasn't found the returned value depends on the passed valueClass:
47    * <ul>
48    * <li>String: null</li>
49    * <li>Boolean: false</li>
50    * <li>List: empty List</li>
51    * <li>Properties: empty Properties</li>
52    * </ul>
53    * @since 2.0M1
54    */
55    <T> T getProperty(String key, Class<T> valueClass);
56   
57    /**
58    * @param <T> the value type
59    * @param key the property key for which we want the value
60    * @return the property as an untyped Object or null if the key wasn't found. In general you should prefer
61    * {@link #getProperty(String, Class)} or {@link #getProperty(String, Object)}
62    */
63    <T> T getProperty(String key);
64   
65    /**
66    * @return the list of available keys in the configuration source
67    */
68    List<String> getKeys();
69   
70    /**
71    * @param key the key to check
72    * @return true if the key is present in the configuration source or false otherwise
73    */
74    boolean containsKey(String key);
75   
76    /**
77    * @return true if the configuration source doesn't have any key or false otherwise
78    */
79    boolean isEmpty();
80    }