io.opencensus.common.Scope Maven / Gradle / Ivy
/*
* 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.
*
* Example of usage:
*
*
* try (Scope ctx = tryEnter()) {
* ...
* }
*
*
* @since 0.6
*/
@SuppressWarnings("deprecation")
public interface Scope extends NonThrowingCloseable {
@Override
void close();
}