diff options
Diffstat (limited to 'api/src/main/java/io/opencensus/common/Scope.java')
-rw-r--r-- | api/src/main/java/io/opencensus/common/Scope.java | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/api/src/main/java/io/opencensus/common/Scope.java b/api/src/main/java/io/opencensus/common/Scope.java new file mode 100644 index 00000000..de954f50 --- /dev/null +++ b/api/src/main/java/io/opencensus/common/Scope.java @@ -0,0 +1,37 @@ +/* + * Copyright 2017, OpenCensus Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.opencensus.common; + +/** + * A {@link java.io.Closeable} that represents a change to the current context over a scope of code. + * {@link Scope#close} cannot throw a checked exception. + * + * <p>Example of usage: + * + * <pre> + * try (Scope ctx = tryEnter()) { + * ... + * } + * </pre> + * + * @since 0.6 + */ +@SuppressWarnings("deprecation") +public interface Scope extends NonThrowingCloseable { + @Override + void close(); +} |