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.util.Iterator;
19
20 /**
21 * Models a collection of properties as {@link String} keys and values to
22 * iterate over.
23 *
24 * @see Property
25 */
26 public interface PropertyCollection extends Iterable<Property>
27 {
28 // ********************************* Fields *********************************
29
30 // --- constants ------------------------------------------------------------
31
32 // ****************************** Initializer *******************************
33
34 // ****************************** Inner Classes *****************************
35
36 // ********************************* Methods ********************************
37
38 // --- get&set --------------------------------------------------------------
39
40 // --- business -------------------------------------------------------------
41
42 /**
43 * Releases all resources used by this collection.
44 */
45 void close();
46
47 /**
48 * Returns an iterator over a set of properties.
49 * <p>
50 * Please note that an implementation may require to call {@link #close()}
51 * after iterating over the values. The client calling {@link #iterator()} is
52 * responsible for closing the collection.
53 * </p>
54 *
55 * @return an iterator.
56 */
57 @Override
58 Iterator<Property> iterator();
59
60 // --- object basics --------------------------------------------------------
61
62 }