diff options
author | Ben McCann <ben@connectifier.com> | 2015-04-21 16:21:01 -0700 |
---|---|---|
committer | Ben McCann <ben@connectifier.com> | 2015-04-21 19:01:45 -0700 |
commit | bac730fa1b717351736182034aff62827a383090 (patch) | |
tree | ea7bfaac39a4fdfc5c57c759a696243b42cf884e | |
parent | e3f556653ce41ff4e133ab45029c261db9ca35f4 (diff) | |
download | guice-bac730fa1b717351736182034aff62827a383090.tar.gz |
Add missing @since tags for 4.0
33 files changed, 69 insertions, 5 deletions
diff --git a/core/src/com/google/inject/PrivateModule.java b/core/src/com/google/inject/PrivateModule.java index cf93f1c7..ba2f7223 100644 --- a/core/src/com/google/inject/PrivateModule.java +++ b/core/src/com/google/inject/PrivateModule.java @@ -297,6 +297,7 @@ public abstract class PrivateModule implements Module { /** * @see Binder#bindListener(Matcher, ProvisionListener...) + * @since 4.0 */ protected void bindListener(Matcher<? super Binding<?>> bindingMatcher, ProvisionListener... listeners) { diff --git a/core/src/com/google/inject/Scopes.java b/core/src/com/google/inject/Scopes.java index 614ffbd3..6c893e52 100644 --- a/core/src/com/google/inject/Scopes.java +++ b/core/src/com/google/inject/Scopes.java @@ -124,6 +124,7 @@ public class Scopes { * @param binding binding to check * @param scope scope implementation instance * @param scopeAnnotation scope annotation class + * @since 4.0 */ public static boolean isScoped(Binding<?> binding, final Scope scope, final Class<? extends Annotation> scopeAnnotation) { @@ -177,6 +178,8 @@ public class Scopes { * because the proxies are not intended for general purpose use. (They are * designed just to fulfill the immediate injection, not all injections. * Caching them can lead to IllegalArgumentExceptions or ClassCastExceptions.) + * + * @since 4.0 */ public static boolean isCircularProxy(Object object) { return object instanceof CircularDependencyProxy; diff --git a/core/src/com/google/inject/binder/LinkedBindingBuilder.java b/core/src/com/google/inject/binder/LinkedBindingBuilder.java index 5ba8b671..99ea1854 100644 --- a/core/src/com/google/inject/binder/LinkedBindingBuilder.java +++ b/core/src/com/google/inject/binder/LinkedBindingBuilder.java @@ -62,6 +62,7 @@ public interface LinkedBindingBuilder<T> extends ScopedBindingBuilder { * See the EDSL examples at {@link com.google.inject.Binder}. * * @see com.google.inject.Injector#injectMembers + * @since 4.0 */ ScopedBindingBuilder toProvider(javax.inject.Provider<? extends T> provider); diff --git a/core/src/com/google/inject/spi/DependencyAndSource.java b/core/src/com/google/inject/spi/DependencyAndSource.java index d2fbb953..ce52aaed 100644 --- a/core/src/com/google/inject/spi/DependencyAndSource.java +++ b/core/src/com/google/inject/spi/DependencyAndSource.java @@ -28,6 +28,7 @@ import java.lang.reflect.Member; * source} where the dependency was bound. * * @author sameb@google.com (Sam Berlin) + * @since 4.0 */ public final class DependencyAndSource { private final Dependency<?> dependency; diff --git a/core/src/com/google/inject/spi/ElementSource.java b/core/src/com/google/inject/spi/ElementSource.java index 8414b215..52783c99 100644 --- a/core/src/com/google/inject/spi/ElementSource.java +++ b/core/src/com/google/inject/spi/ElementSource.java @@ -54,6 +54,8 @@ import java.util.List; * created from another Guice {@link Element element} (original) (e.g., by * {@link Element#applyTo}), it also provides a reference to the original * element source ({@link #getOriginalElementSource()}). + * + * @since 4.0 */ public final class ElementSource { diff --git a/core/src/com/google/inject/spi/ModuleAnnotatedMethodScanner.java b/core/src/com/google/inject/spi/ModuleAnnotatedMethodScanner.java index 36adc852..3c908257 100644 --- a/core/src/com/google/inject/spi/ModuleAnnotatedMethodScanner.java +++ b/core/src/com/google/inject/spi/ModuleAnnotatedMethodScanner.java @@ -25,6 +25,8 @@ import java.util.Set; /** * Allows extensions to scan modules for annotated methods and bind those methods * as providers, similar to {@code @Provides} methods. + * + * @since 4.0 */ public abstract class ModuleAnnotatedMethodScanner { diff --git a/core/src/com/google/inject/spi/ProviderInstanceBinding.java b/core/src/com/google/inject/spi/ProviderInstanceBinding.java index ab4aaa48..99cd9db9 100644 --- a/core/src/com/google/inject/spi/ProviderInstanceBinding.java +++ b/core/src/com/google/inject/spi/ProviderInstanceBinding.java @@ -39,7 +39,10 @@ public interface ProviderInstanceBinding<T> extends Binding<T>, HasDependencies @Deprecated Provider<? extends T> getProviderInstance(); - /** Returns the user-supplied, unscoped provider. */ + /** + * Returns the user-supplied, unscoped provider. + * @since 4.0 + */ javax.inject.Provider<? extends T> getUserSuppliedProvider(); /** diff --git a/core/src/com/google/inject/spi/ProvisionListener.java b/core/src/com/google/inject/spi/ProvisionListener.java index e3f06bde..274b8c39 100644 --- a/core/src/com/google/inject/spi/ProvisionListener.java +++ b/core/src/com/google/inject/spi/ProvisionListener.java @@ -49,7 +49,11 @@ public interface ProvisionListener { */ <T> void onProvision(ProvisionInvocation<T> provision); - /** Encapsulates a single act of provisioning.*/ + /** + * Encapsulates a single act of provisioning. + * + * @since 4.0 + */ public abstract static class ProvisionInvocation<T> { /** diff --git a/extensions/grapher/src/com/google/inject/grapher/AbstractInjectorGrapher.java b/extensions/grapher/src/com/google/inject/grapher/AbstractInjectorGrapher.java index da90ba3c..940caab6 100644 --- a/extensions/grapher/src/com/google/inject/grapher/AbstractInjectorGrapher.java +++ b/extensions/grapher/src/com/google/inject/grapher/AbstractInjectorGrapher.java @@ -32,6 +32,7 @@ import java.util.Set; * Abstract injector grapher that builds the dependency graph but doesn't render it. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public abstract class AbstractInjectorGrapher implements InjectorGrapher { private final RootKeySetCreator rootKeySetCreator; @@ -39,7 +40,10 @@ public abstract class AbstractInjectorGrapher implements InjectorGrapher { private final NodeCreator nodeCreator; private final EdgeCreator edgeCreator; - /** Parameters used to override default settings of the grapher. */ + /** + * Parameters used to override default settings of the grapher. + * @since 4.0 + */ public static final class GrapherParameters { private RootKeySetCreator rootKeySetCreator = new DefaultRootKeySetCreator(); private AliasCreator aliasCreator = new ProviderAliasCreator(); diff --git a/extensions/grapher/src/com/google/inject/grapher/Alias.java b/extensions/grapher/src/com/google/inject/grapher/Alias.java index eb687369..bc20ca9c 100644 --- a/extensions/grapher/src/com/google/inject/grapher/Alias.java +++ b/extensions/grapher/src/com/google/inject/grapher/Alias.java @@ -21,6 +21,7 @@ package com.google.inject.grapher; * that the 'from' node is not rendered and all edges going to it instead go to the 'to' node. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public final class Alias { private final NodeId fromId; diff --git a/extensions/grapher/src/com/google/inject/grapher/AliasCreator.java b/extensions/grapher/src/com/google/inject/grapher/AliasCreator.java index db9751ef..cd428acf 100644 --- a/extensions/grapher/src/com/google/inject/grapher/AliasCreator.java +++ b/extensions/grapher/src/com/google/inject/grapher/AliasCreator.java @@ -23,6 +23,7 @@ import com.google.inject.Binding; * into a single node on the rendered graph. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public interface AliasCreator { /** diff --git a/extensions/grapher/src/com/google/inject/grapher/DefaultRootKeySetCreator.java b/extensions/grapher/src/com/google/inject/grapher/DefaultRootKeySetCreator.java index ce73f175..cf44d46d 100644 --- a/extensions/grapher/src/com/google/inject/grapher/DefaultRootKeySetCreator.java +++ b/extensions/grapher/src/com/google/inject/grapher/DefaultRootKeySetCreator.java @@ -29,6 +29,7 @@ import java.util.logging.Logger; * {@link Logger} type. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public class DefaultRootKeySetCreator implements RootKeySetCreator { private static final Key<Logger> loggerKey = Key.get(Logger.class); diff --git a/extensions/grapher/src/com/google/inject/grapher/Edge.java b/extensions/grapher/src/com/google/inject/grapher/Edge.java index 52a13143..40a3df05 100644 --- a/extensions/grapher/src/com/google/inject/grapher/Edge.java +++ b/extensions/grapher/src/com/google/inject/grapher/Edge.java @@ -22,6 +22,7 @@ import com.google.common.base.Objects; * Edge in a guice dependency graph. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public abstract class Edge { private final NodeId fromId; diff --git a/extensions/grapher/src/com/google/inject/grapher/EdgeCreator.java b/extensions/grapher/src/com/google/inject/grapher/EdgeCreator.java index 3c015b6d..f14e71f8 100644 --- a/extensions/grapher/src/com/google/inject/grapher/EdgeCreator.java +++ b/extensions/grapher/src/com/google/inject/grapher/EdgeCreator.java @@ -23,6 +23,7 @@ import com.google.inject.Binding; * performed. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public interface EdgeCreator { diff --git a/extensions/grapher/src/com/google/inject/grapher/InjectorGrapher.java b/extensions/grapher/src/com/google/inject/grapher/InjectorGrapher.java index 91fd92c4..37bd6e13 100644 --- a/extensions/grapher/src/com/google/inject/grapher/InjectorGrapher.java +++ b/extensions/grapher/src/com/google/inject/grapher/InjectorGrapher.java @@ -30,12 +30,16 @@ import java.util.Set; */ public interface InjectorGrapher { - /** Graphs the guice dependency graph for the given injector using default starting keys. */ + /** + * Graphs the guice dependency graph for the given injector using default starting keys. + * @since 4.0 + */ void graph(Injector injector) throws IOException; /** * Graphs the guice dependency graph for the given injector using the given starting keys and * their transitive dependencies. + * @since 4.0 */ void graph(Injector injector, Set<Key<?>> root) throws IOException; } diff --git a/extensions/grapher/src/com/google/inject/grapher/InstanceNode.java b/extensions/grapher/src/com/google/inject/grapher/InstanceNode.java index cda56bcb..0aaa19b1 100644 --- a/extensions/grapher/src/com/google/inject/grapher/InstanceNode.java +++ b/extensions/grapher/src/com/google/inject/grapher/InstanceNode.java @@ -23,6 +23,7 @@ import java.lang.reflect.Member; * Node for instances. Used when a type is bound to an instance. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public class InstanceNode extends Node { private final Object instance; diff --git a/extensions/grapher/src/com/google/inject/grapher/Node.java b/extensions/grapher/src/com/google/inject/grapher/Node.java index 870f8050..ace85a50 100644 --- a/extensions/grapher/src/com/google/inject/grapher/Node.java +++ b/extensions/grapher/src/com/google/inject/grapher/Node.java @@ -22,6 +22,7 @@ import com.google.common.base.Objects; * Node in a guice dependency graph. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public abstract class Node { /** diff --git a/extensions/grapher/src/com/google/inject/grapher/NodeCreator.java b/extensions/grapher/src/com/google/inject/grapher/NodeCreator.java index e22688f0..d4483701 100644 --- a/extensions/grapher/src/com/google/inject/grapher/NodeCreator.java +++ b/extensions/grapher/src/com/google/inject/grapher/NodeCreator.java @@ -22,6 +22,7 @@ import com.google.inject.Binding; * Creator of graph nodes. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public interface NodeCreator { diff --git a/extensions/grapher/src/com/google/inject/grapher/NodeId.java b/extensions/grapher/src/com/google/inject/grapher/NodeId.java index eaf3f159..d29d3f59 100644 --- a/extensions/grapher/src/com/google/inject/grapher/NodeId.java +++ b/extensions/grapher/src/com/google/inject/grapher/NodeId.java @@ -27,10 +27,14 @@ import com.google.inject.Key; * {@link Key} and value of 42. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public final class NodeId { - /** Type of node. */ + /** + * Type of node. + * @since 4.0 + */ public enum NodeType { /** Type or class node. */ TYPE, diff --git a/extensions/grapher/src/com/google/inject/grapher/RootKeySetCreator.java b/extensions/grapher/src/com/google/inject/grapher/RootKeySetCreator.java index f9e37d3e..12114d8b 100644 --- a/extensions/grapher/src/com/google/inject/grapher/RootKeySetCreator.java +++ b/extensions/grapher/src/com/google/inject/grapher/RootKeySetCreator.java @@ -25,6 +25,7 @@ import java.util.Set; * dependencies will be graphed. * * @author bojand@google.com (Bojan Djordjevic) + * @since 4.0 */ public interface RootKeySetCreator { diff --git a/extensions/grapher/src/com/google/inject/grapher/graphviz/GraphvizGrapher.java b/extensions/grapher/src/com/google/inject/grapher/graphviz/GraphvizGrapher.java index ff8f8b58..71edd09d 100644 --- a/extensions/grapher/src/com/google/inject/grapher/graphviz/GraphvizGrapher.java +++ b/extensions/grapher/src/com/google/inject/grapher/graphviz/GraphvizGrapher.java @@ -44,6 +44,7 @@ import java.util.Map.Entry; * Specify the {@link PrintWriter} to output to with {@link #setOut(PrintWriter)}. * * @author phopkins@gmail.com (Pete Hopkins) + * @since 4.0 */ public class GraphvizGrapher extends AbstractInjectorGrapher { private final Map<NodeId, GraphvizNode> nodes = Maps.newHashMap(); diff --git a/extensions/multibindings/src/com/google/inject/multibindings/ClassMapKey.java b/extensions/multibindings/src/com/google/inject/multibindings/ClassMapKey.java index 47c8c17d..d12fe606 100644 --- a/extensions/multibindings/src/com/google/inject/multibindings/ClassMapKey.java +++ b/extensions/multibindings/src/com/google/inject/multibindings/ClassMapKey.java @@ -25,6 +25,8 @@ import java.lang.annotation.Target; /** * Allows {@literal @}{@link ProvidesIntoMap} to specify a class map key. + * + * @since 4.0 */ @MapKey(unwrapValue = true) @Documented diff --git a/extensions/multibindings/src/com/google/inject/multibindings/MapKey.java b/extensions/multibindings/src/com/google/inject/multibindings/MapKey.java index 2fc3374d..830f3291 100644 --- a/extensions/multibindings/src/com/google/inject/multibindings/MapKey.java +++ b/extensions/multibindings/src/com/google/inject/multibindings/MapKey.java @@ -44,6 +44,8 @@ import java.lang.annotation.Target; * When unwrapValue is false, the annotation type will be the key type for the injected map and * the annotation instances will be the key values. If {@code unwrapValue=true}, the value() type * will be the key type for injected map and the value() instances will be the keys values. + * + * @since 4.0 */ @Documented @Target(ANNOTATION_TYPE) diff --git a/extensions/multibindings/src/com/google/inject/multibindings/Multibinder.java b/extensions/multibindings/src/com/google/inject/multibindings/Multibinder.java index 56433f78..5491308d 100644 --- a/extensions/multibindings/src/com/google/inject/multibindings/Multibinder.java +++ b/extensions/multibindings/src/com/google/inject/multibindings/Multibinder.java @@ -162,6 +162,7 @@ public abstract class Multibinder<T> { /** * Returns a new multibinder that collects instances of the key's type in a {@link Set} that is * itself bound with the annotation (if any) of the key. + * @since 4.0 */ public static <T> Multibinder<T> newSetBinder(Binder binder, Key<T> key) { return newRealSetBinder(binder, key); diff --git a/extensions/multibindings/src/com/google/inject/multibindings/MultibindingsScanner.java b/extensions/multibindings/src/com/google/inject/multibindings/MultibindingsScanner.java index 02fce320..95b4d5fa 100644 --- a/extensions/multibindings/src/com/google/inject/multibindings/MultibindingsScanner.java +++ b/extensions/multibindings/src/com/google/inject/multibindings/MultibindingsScanner.java @@ -32,6 +32,8 @@ import java.util.Set; /** * Scans a module for annotations that signal multibindings, mapbindings, and optional bindings. + * + * @since 4.0 */ public class MultibindingsScanner { diff --git a/extensions/multibindings/src/com/google/inject/multibindings/OptionalBinder.java b/extensions/multibindings/src/com/google/inject/multibindings/OptionalBinder.java index d18f974d..1986e7ca 100644 --- a/extensions/multibindings/src/com/google/inject/multibindings/OptionalBinder.java +++ b/extensions/multibindings/src/com/google/inject/multibindings/OptionalBinder.java @@ -162,6 +162,7 @@ import javax.inject.Qualifier; * {@code @LookupUrl String}. * * @author sameb@google.com (Sam Berlin) + * @since 4.0 */ public abstract class OptionalBinder<T> { diff --git a/extensions/multibindings/src/com/google/inject/multibindings/ProvidesIntoOptional.java b/extensions/multibindings/src/com/google/inject/multibindings/ProvidesIntoOptional.java index 6f021700..23576f66 100644 --- a/extensions/multibindings/src/com/google/inject/multibindings/ProvidesIntoOptional.java +++ b/extensions/multibindings/src/com/google/inject/multibindings/ProvidesIntoOptional.java @@ -50,6 +50,9 @@ import java.lang.annotation.Target; @Target(METHOD) @Retention(RUNTIME) public @interface ProvidesIntoOptional { + /** + * @since 4.0 + */ enum Type { /** Corresponds to {@link OptionalBinder#setBinding}. */ ACTUAL, diff --git a/extensions/multibindings/src/com/google/inject/multibindings/StringMapKey.java b/extensions/multibindings/src/com/google/inject/multibindings/StringMapKey.java index dd4d99bc..4cf0eccb 100644 --- a/extensions/multibindings/src/com/google/inject/multibindings/StringMapKey.java +++ b/extensions/multibindings/src/com/google/inject/multibindings/StringMapKey.java @@ -25,6 +25,7 @@ import java.lang.annotation.Target; /** * Allows {@literal @}{@link ProvidesIntoMap} to specify a string map key. + * @since 4.0 */ @MapKey(unwrapValue = true) @Documented diff --git a/extensions/servlet/src/com/google/inject/servlet/ScopingException.java b/extensions/servlet/src/com/google/inject/servlet/ScopingException.java index 22f90f1a..1513959f 100644 --- a/extensions/servlet/src/com/google/inject/servlet/ScopingException.java +++ b/extensions/servlet/src/com/google/inject/servlet/ScopingException.java @@ -20,6 +20,7 @@ package com.google.inject.servlet; * Exception thrown when there was a failure entering request scope. * * @author Chris Nokleberg + * @since 4.0 */ public final class ScopingException extends IllegalStateException { public ScopingException(String message) { diff --git a/extensions/servlet/src/com/google/inject/servlet/ScopingOnly.java b/extensions/servlet/src/com/google/inject/servlet/ScopingOnly.java index 6a4d310f..d828d75d 100644 --- a/extensions/servlet/src/com/google/inject/servlet/ScopingOnly.java +++ b/extensions/servlet/src/com/google/inject/servlet/ScopingOnly.java @@ -29,6 +29,7 @@ import java.lang.annotation.Target; * doesn't dispatch to {@link ServletModule} bound servlets or filters. * * @author iqshum@google.com (Isaac Shum) + * @since 4.0 */ @Retention(RUNTIME) @Target({ ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD }) diff --git a/extensions/servlet/src/com/google/inject/servlet/ServletScopes.java b/extensions/servlet/src/com/google/inject/servlet/ServletScopes.java index 25020cab..54c120e5 100644 --- a/extensions/servlet/src/com/google/inject/servlet/ServletScopes.java +++ b/extensions/servlet/src/com/google/inject/servlet/ServletScopes.java @@ -256,6 +256,7 @@ public class ServletScopes { * context available to it. * @throws OutOfScopeException if this method is called from a non-request * thread, or if the request has completed. + * @since 4.0 */ public static <T> Callable<T> transferRequest(Callable<T> callable) { return (GuiceFilter.localContext.get() != null) @@ -293,6 +294,8 @@ public class ServletScopes { * belongs to an injector (i. e. it was retrieved via * {@link Injector#getBinding Injector.getBinding()}), then this method will * also return true if the target binding is request-scoped. + * + * @since 4.0 */ public static boolean isRequestScoped(Binding<?> binding) { return Scopes.isScoped(binding, ServletScopes.REQUEST, RequestScoped.class); diff --git a/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingInject.java b/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingInject.java index 6d188822..445d6970 100644 --- a/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingInject.java +++ b/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingInject.java @@ -34,6 +34,7 @@ import java.lang.annotation.Target; * where CustomerImpl has a constructor annotated with ThrowingInject. * * @author sameb@google.com (Sam Berlin) + * @since 4.0 */ @Target({ CONSTRUCTOR }) @Retention(RUNTIME) diff --git a/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java b/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java index de33d2c7..24cbd26c 100644 --- a/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java +++ b/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java @@ -121,11 +121,17 @@ public class ThrowingProviderBinder { return new SecondaryBinder<P, Object>(interfaceType, clazz); } + /** + * @since 4.0 + */ public <P extends CheckedProvider, T> SecondaryBinder<P, T> bind(Class<P> interfaceType, Class<T> clazz) { return new SecondaryBinder<P, T>(interfaceType, clazz); } + /** + * @since 4.0 + */ public <P extends CheckedProvider, T> SecondaryBinder<P, T> bind(Class<P> interfaceType, TypeLiteral<T> typeLiteral) { return new SecondaryBinder<P, T>(interfaceType, typeLiteral.getType()); @@ -181,6 +187,7 @@ public class ThrowingProviderBinder { /** * Determines if exceptions should be scoped. By default exceptions are scoped. * @param scopeExceptions whether exceptions should be scoped. + * @since 4.0 */ public SecondaryBinder<P, T> scopeExceptions(boolean scopeExceptions) { this.scopeExceptions = scopeExceptions; |