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