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;
17
18 import java.io.Serializable;
19
20 /**
21 * Provides access to all configuration properties for a given application in a
22 * given environment.
23 * <p>
24 * There are two ways to access property values.
25 * </p>
26 * <ol>
27 * <li>Use {@link #getProperties(Class)} to obtain an implementation of an
28 * interface that provides access to the property values through its methods.
29 * This is the recommended way to deal with properties.</li>
30 * <li>Use one of the {@code getProperty} methods. This access may be more
31 * convenient, if the context deals with property keys that are provided by the
32 * user (e.g. from an UI).</li>
33 * </ol>
34 *
35 * @impl This interface is intended to be implemented by service providers. API
36 * users are intended to us this interface to access properties. For
37 * details on creating instances of classes implementing this interface
38 * please refer to {@link de.smartics.properties.api.config}.
39 */
40 public interface SerializableConfigurationProperties extends ConfigurationProperties, Serializable
41 {
42 // ********************************* Fields *********************************
43
44 // --- constants ------------------------------------------------------------
45
46 // ****************************** Initializer *******************************
47
48 // ****************************** Inner Classes *****************************
49
50 // ********************************* Methods ********************************
51
52 // --- get&set --------------------------------------------------------------
53
54 // --- business -------------------------------------------------------------
55
56 // --- object basics --------------------------------------------------------
57
58 // --- object basics --------------------------------------------------------
59
60 }