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