01 /*
02 * Java Genetic Algorithm Library (jenetics-1.6.0).
03 * Copyright (c) 2007-2014 Franz Wilhelmstötter
04 *
05 * Licensed under the Apache License, Version 2.0 (the "License");
06 * you may not use this file except in compliance with the License.
07 * You may obtain a copy of the License at
08 *
09 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author:
18 * Franz Wilhelmstötter (franz.wilhelmstoetter@gmx.at)
19 */
20 package org.jenetics.util;
21
22 /**
23 * Defines a local scope, where the containing value is valid. When the scope is
24 * left, the original value is restored. A <i>scoped</i> value is usually used
25 * within a {@code try} block.
26 * [code]
27 * try (Scoped<Random> s = RandomRegistry.scope(new Random(123))) {
28 * System.out.println(s.get().nextDouble());
29 * }
30 * [/code]
31 *
32 * In the example above, the new random engine is only used within the defined
33 * scope.
34 *
35 * @author <a href="mailto:franz.wilhelmstoetter@gmx.at">Franz Wilhelmstötter</a>
36 * @version 1.6 — <em>$Date: 2014-02-24 $</em>
37 * @since 1.6
38 */
39 public interface Scoped<T> extends AutoCloseable {
40
41 /**
42 * Return the scoped object.
43 *
44 * @return the scoped object.
45 */
46 public T get();
47
48 /**
49 * Closing this scope and restoring the original state.
50 */
51 public void close();
52
53 }
|