1 /** 2 * Copyright (C) 2010 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 import static java.lang.annotation.ElementType.METHOD; 20 import static java.lang.annotation.RetentionPolicy.RUNTIME; 21 22 import java.lang.annotation.Documented; 23 import java.lang.annotation.Retention; 24 import java.lang.annotation.Target; 25 26 /** 27 * Annotates methods of a {@link com.google.inject.Module} to create a 28 * {@link CheckedProvider} method binding that can throw exceptions. The 29 * method's return type is bound to a {@link CheckedProvider} that can be 30 * injected. Guice will pass dependencies to the method as parameters. Install 31 * {@literal @}CheckedProvides methods by using 32 * {@link ThrowingProviderBinder#forModule(com.google.inject.Module)} on the 33 * module where the methods are declared. 34 * 35 * @author sameb (at) google.com (Sam Berlin) 36 * @since 3.0 37 */ 38 @Documented @Target(METHOD) @Retention(RUNTIME) 39 public @interface CheckedProvides { 40 41 /** 42 * The interface that provides this value, a subinterface of {@link CheckedProvider}. 43 */ 44 Class<? extends CheckedProvider> value(); 45 46 /** 47 * Whether exceptions should be put into the Guice scope. 48 * Default behavior is that exceptions are scoped. 49 * 50 * @since 4.0 51 */ 52 boolean scopeExceptions() default true; 53 } 54
