1 /* 2 * Copyright 2017, OpenCensus Authors 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 17 package io.opencensus.common; 18 19 /** 20 * A {@link java.io.Closeable} that represents a change to the current context over a scope of code. 21 * {@link Scope#close} cannot throw a checked exception. 22 * 23 * <p>Example of usage: 24 * 25 * <pre> 26 * try (Scope ctx = tryEnter()) { 27 * ... 28 * } 29 * </pre> 30 * 31 * @since 0.6 32 */ 33 @SuppressWarnings("deprecation") 34 public interface Scope extends NonThrowingCloseable { 35 @Override close()36 void close(); 37 } 38