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.resource.heap;
17
18 import de.smartics.properties.resource.domain.ClassPathEnvironment;
19
20 /**
21 * Interface to a repository that provides properties resources. These resources
22 * include property descriptors and property definitions.
23 * <p>
24 * A repository may be some local file directory or it may provide access to a
25 * remote artifact repository.
26 * </p>
27 */
28 public interface ResourceHeap
29 {
30 // ********************************* Fields *********************************
31
32 // --- constants ------------------------------------------------------------
33
34 // ****************************** Initializer *******************************
35
36 // ****************************** Inner Classes *****************************
37
38 // ********************************* Methods ********************************
39
40 // --- get&set --------------------------------------------------------------
41
42 // --- business -------------------------------------------------------------
43
44 /**
45 * Resolves the properties resources from this heap.
46 *
47 * @return the properties resources.
48 * @throws HeapException on any problem accessing the heap.
49 */
50 ClassPathEnvironment resolve() throws HeapException;
51
52 // --- object basics --------------------------------------------------------
53
54 }