1 /*
2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.properties.api.config.domain.key;
17
18 import java.util.List;
19
20 /**
21 * Creates a list of keys to search for properties value in a given order.
22 */
23 public interface KeyListBuilder
24 {
25 // ********************************* Fields *********************************
26
27 // --- constants ------------------------------------------------------------
28
29 // ****************************** Initializer *******************************
30
31 // ****************************** Inner Classes *****************************
32
33 // ********************************* Methods ********************************
34
35 // --- get&set --------------------------------------------------------------
36
37 // --- business -------------------------------------------------------------
38
39 /**
40 * Creates a list of keys to search for properties value in a given order.
41 *
42 * @param key the fully qualified key of the runtime environment.
43 * @return a list of configuration keys the implementation decides to use in
44 * queries for property values. The list must contain at least one key
45 * which is usually the passed in key. In this case only the exactly
46 * matching configuration is queried.
47 */
48 List<ConfigurationKey<?>> createKeyList(final ConfigurationKey<?> key);
49
50 // --- object basics --------------------------------------------------------
51
52 }