1 /** 2 * Copyright (C) 2007 Google Inc. 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 com.google.inject.throwingproviders; 18 19 /** 20 * Alternative to the Guice {@link com.google.inject.Provider} that throws 21 * a checked Exception. Users may not inject {@code T} directly. 22 * 23 * <p>This interface must be extended to use application-specific exception types. 24 * Such subinterfaces may not define new methods, but may narrow the exception type. 25 * <pre> 26 * public interface RemoteProvider<T> extends CheckedProvider<T> { 27 * T get() throws CustomExceptionOne, CustomExceptionTwo; 28 * } 29 * </pre> 30 * 31 * <p>When this type is bound using {@link ThrowingProviderBinder}, the value returned 32 * or exception thrown by {@link #get} will be scoped. As a consequence, {@link #get} 33 * will invoked at most once within each scope. 34 * 35 * @since 3.0 36 */ 37 public interface CheckedProvider<T> { 38 T get() throws Exception; 39 } 40
