limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 1 | /** |
| 2 | * Copyright (C) 2008 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.commands; |
| 18 | |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 19 | import com.google.inject.*; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 20 | import com.google.inject.binder.AnnotatedBindingBuilder; |
| 21 | import com.google.inject.binder.ConstantBindingBuilder; |
| 22 | import com.google.inject.binder.LinkedBindingBuilder; |
| 23 | import com.google.inject.binder.ScopedBindingBuilder; |
limpbizkit | 8b23745 | 2008-04-22 06:47:36 +0000 | [diff] [blame] | 24 | import com.google.inject.internal.ErrorMessages; |
limpbizkit | d6967b9 | 2008-05-16 15:28:51 +0000 | [diff] [blame^] | 25 | import static com.google.inject.internal.Objects.nonNull; |
| 26 | import com.google.inject.spi.SourceProviders; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 27 | |
| 28 | import java.lang.annotation.Annotation; |
| 29 | |
| 30 | /** |
| 31 | * Immutable snapshot of a request to bind a value. |
| 32 | * |
| 33 | * @author jessewilson@google.com (Jesse Wilson) |
| 34 | */ |
| 35 | public final class BindCommand<T> implements Command { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 36 | |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 37 | static { |
| 38 | SourceProviders.skip(BindCommand.BindingBuilder.class); |
| 39 | } |
| 40 | |
| 41 | private static final BindTarget<Object> EMPTY_BIND_TARGET = new AbstractTarget<Object>() { |
| 42 | public ScopedBindingBuilder execute(LinkedBindingBuilder<Object> linkedBindingBuilder) { |
| 43 | return linkedBindingBuilder; |
| 44 | } |
| 45 | public <V> V acceptVisitor(Visitor<Object, V> visitor) { |
| 46 | return visitor.visitUntargetted(); |
| 47 | } |
| 48 | }; |
| 49 | |
| 50 | private static final BindScoping EMPTY_SCOPING = new AbstractScoping() { |
| 51 | public void execute(ScopedBindingBuilder scopedBindingBuilder) { |
| 52 | // do nothing |
| 53 | } |
| 54 | public <V> V acceptVisitor(Visitor<V> visitor) { |
| 55 | return visitor.visitNoScoping(); |
| 56 | } |
| 57 | }; |
| 58 | |
| 59 | private final Object source; |
| 60 | private Key<T> key; |
| 61 | @SuppressWarnings({"unchecked"}) |
| 62 | private BindTarget<T> bindTarget = (BindTarget<T>) EMPTY_BIND_TARGET; |
| 63 | private BindScoping bindScoping = EMPTY_SCOPING; |
| 64 | |
| 65 | BindCommand(Object source, Key<T> key) { |
| 66 | this.source = nonNull(source, "source"); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 67 | this.key = nonNull(key, "key"); |
| 68 | } |
| 69 | |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 70 | public Object getSource() { |
| 71 | return source; |
| 72 | } |
| 73 | |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 74 | public <V> V acceptVisitor(Visitor<V> visitor) { |
| 75 | return visitor.visitBind(this); |
| 76 | } |
| 77 | |
| 78 | public Key<T> getKey() { |
| 79 | return key; |
| 80 | } |
| 81 | |
| 82 | public BindTarget<T> getTarget() { |
| 83 | return bindTarget; |
| 84 | } |
| 85 | |
| 86 | public BindScoping getScoping() { |
| 87 | return bindScoping; |
| 88 | } |
| 89 | |
| 90 | @Override public String toString() { |
| 91 | return "bind " + key |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 92 | + (bindTarget == EMPTY_BIND_TARGET ? "" : (" to " + bindTarget)) |
| 93 | + (bindScoping == EMPTY_SCOPING ? "" : (" in " + bindScoping)); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | private static abstract class AbstractTarget<T> implements BindTarget<T> { |
| 97 | public void execute(ConstantBindingBuilder builder) { |
| 98 | throw new UnsupportedOperationException(); |
| 99 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 100 | public T get() { |
| 101 | return null; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 102 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 103 | public Key<? extends Provider<? extends T>> getProviderKey() { |
| 104 | return null; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 105 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 106 | public Provider<? extends T> getProvider() { |
| 107 | return null; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 108 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 109 | public Key<? extends T> getKey() { |
| 110 | return null; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 111 | } |
| 112 | } |
| 113 | |
| 114 | private static abstract class AbstractScoping implements BindScoping { |
| 115 | public boolean isEagerSingleton() { |
| 116 | return false; |
| 117 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 118 | public Scope getScope() { |
| 119 | return null; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 120 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 121 | public Class<? extends Annotation> getScopeAnnotation() { |
| 122 | return null; |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 123 | } |
| 124 | } |
| 125 | |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 126 | BindingBuilder bindingBuilder(Binder binder) { |
| 127 | return new BindingBuilder(binder); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Package-private write access to the internal state of this command. |
| 132 | */ |
| 133 | class BindingBuilder implements AnnotatedBindingBuilder<T> { |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 134 | private final Binder binder; |
| 135 | |
| 136 | BindingBuilder(Binder binder) { |
| 137 | this.binder = binder; |
| 138 | } |
| 139 | |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 140 | public LinkedBindingBuilder<T> annotatedWith( |
| 141 | Class<? extends Annotation> annotationType) { |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 142 | nonNull(annotationType, "annotationType"); |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 143 | checkNotAnnotated(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 144 | key = Key.get(key.getTypeLiteral(), annotationType); |
| 145 | return this; |
| 146 | } |
| 147 | |
| 148 | public LinkedBindingBuilder<T> annotatedWith(Annotation annotation) { |
| 149 | nonNull(annotation, "annotation"); |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 150 | checkNotAnnotated(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 151 | key = Key.get(key.getTypeLiteral(), annotation); |
| 152 | return this; |
| 153 | } |
| 154 | |
| 155 | public ScopedBindingBuilder to(final Class<? extends T> implementation) { |
| 156 | return to(Key.get(implementation)); |
| 157 | } |
| 158 | |
| 159 | public ScopedBindingBuilder to( |
| 160 | final TypeLiteral<? extends T> implementation) { |
| 161 | return to(Key.get(implementation)); |
| 162 | } |
| 163 | |
| 164 | public ScopedBindingBuilder to(final Key<? extends T> targetKey) { |
| 165 | nonNull(targetKey, "targetKey"); |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 166 | checkNotTargetted(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 167 | bindTarget = new AbstractTarget<T>() { |
| 168 | public ScopedBindingBuilder execute(LinkedBindingBuilder<T> linkedBindingBuilder) { |
| 169 | return linkedBindingBuilder.to(targetKey); |
| 170 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 171 | @Override public Key<? extends T> getKey() { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 172 | return targetKey; |
| 173 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 174 | public <V> V acceptVisitor(Visitor<T, V> visitor) { |
| 175 | return visitor.visitToKey(targetKey); |
| 176 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 177 | @Override public String toString() { |
| 178 | return String.valueOf(targetKey); |
| 179 | } |
| 180 | }; |
| 181 | return this; |
| 182 | } |
| 183 | |
| 184 | public void toInstance(final T instance) { |
limpbizkit | 8b23745 | 2008-04-22 06:47:36 +0000 | [diff] [blame] | 185 | nonNull(instance, ErrorMessages.CANNOT_BIND_TO_NULL_INSTANCE); |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 186 | |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 187 | checkNotTargetted(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 188 | bindTarget = new AbstractTarget<T>() { |
| 189 | public ScopedBindingBuilder execute(LinkedBindingBuilder<T> linkedBindingBuilder) { |
| 190 | linkedBindingBuilder.toInstance(instance); |
| 191 | return null; |
| 192 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 193 | @Override public T get() { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 194 | return instance; |
| 195 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 196 | public <V> V acceptVisitor(Visitor<T, V> visitor) { |
| 197 | return visitor.visitToInstance(instance); |
| 198 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 199 | @Override public String toString() { |
| 200 | return "instance " + instance; |
| 201 | } |
| 202 | }; |
| 203 | } |
| 204 | |
| 205 | public ScopedBindingBuilder toProvider(final Provider<? extends T> provider) { |
| 206 | nonNull(provider, "provider"); |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 207 | checkNotTargetted(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 208 | bindTarget = new AbstractTarget<T>() { |
| 209 | public ScopedBindingBuilder execute(LinkedBindingBuilder<T> linkedBindingBuilder) { |
| 210 | return linkedBindingBuilder.toProvider(provider); |
| 211 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 212 | @Override public Provider<? extends T> getProvider() { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 213 | return provider; |
| 214 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 215 | public <V> V acceptVisitor(Visitor<T, V> visitor) { |
| 216 | return visitor.visitToProvider(provider); |
| 217 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 218 | @Override public String toString() { |
| 219 | return "provider " + provider; |
| 220 | } |
| 221 | }; |
| 222 | return this; |
| 223 | } |
| 224 | |
| 225 | public ScopedBindingBuilder toProvider( |
| 226 | Class<? extends Provider<? extends T>> providerType) { |
| 227 | return toProvider(Key.get(providerType)); |
| 228 | } |
| 229 | |
| 230 | public ScopedBindingBuilder toProvider( |
| 231 | final Key<? extends Provider<? extends T>> providerKey) { |
| 232 | nonNull(providerKey, "providerKey"); |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 233 | checkNotTargetted(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 234 | bindTarget = new AbstractTarget<T>() { |
| 235 | public ScopedBindingBuilder execute(LinkedBindingBuilder<T> linkedBindingBuilder) { |
| 236 | return linkedBindingBuilder.toProvider(providerKey); |
| 237 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 238 | @Override public Key<? extends Provider<? extends T>> getProviderKey() { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 239 | return providerKey; |
| 240 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 241 | public <V> V acceptVisitor(Visitor<T, V> visitor) { |
| 242 | return visitor.visitToProviderKey(providerKey); |
| 243 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 244 | @Override public String toString() { |
| 245 | return "provider " + providerKey; |
| 246 | } |
| 247 | }; |
| 248 | return this; |
| 249 | } |
| 250 | |
| 251 | public void in(final Class<? extends Annotation> scopeAnnotation) { |
| 252 | nonNull(scopeAnnotation, "scopeAnnotation"); |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 253 | checkNotScoped(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 254 | |
| 255 | bindScoping = new AbstractScoping() { |
| 256 | public void execute(ScopedBindingBuilder scopedBindingBuilder) { |
| 257 | scopedBindingBuilder.in(scopeAnnotation); |
| 258 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 259 | @Override public Class<? extends Annotation> getScopeAnnotation() { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 260 | return scopeAnnotation; |
| 261 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 262 | public <V> V acceptVisitor(Visitor<V> visitor) { |
| 263 | return visitor.visitScopeAnnotation(scopeAnnotation); |
| 264 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 265 | @Override public String toString() { |
| 266 | return scopeAnnotation.getName(); |
| 267 | } |
| 268 | }; |
| 269 | } |
| 270 | |
| 271 | public void in(final Scope scope) { |
| 272 | nonNull(scope, "scope"); |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 273 | checkNotScoped(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 274 | bindScoping = new AbstractScoping() { |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 275 | |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 276 | public void execute(ScopedBindingBuilder scopedBindingBuilder) { |
| 277 | scopedBindingBuilder.in(scope); |
| 278 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 279 | @Override public Scope getScope() { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 280 | return scope; |
| 281 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 282 | public <V> V acceptVisitor(Visitor<V> visitor) { |
| 283 | return visitor.visitScope(scope); |
| 284 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 285 | @Override public String toString() { |
| 286 | return String.valueOf(scope); |
| 287 | } |
| 288 | }; |
| 289 | } |
| 290 | |
| 291 | public void asEagerSingleton() { |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 292 | checkNotScoped(); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 293 | bindScoping = new AbstractScoping() { |
| 294 | public void execute(ScopedBindingBuilder scopedBindingBuilder) { |
| 295 | scopedBindingBuilder.asEagerSingleton(); |
| 296 | } |
| 297 | @Override public boolean isEagerSingleton() { |
| 298 | return true; |
| 299 | } |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 300 | public <V> V acceptVisitor(Visitor<V> visitor) { |
| 301 | return visitor.visitEagerSingleton(); |
| 302 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 303 | @Override public String toString() { |
| 304 | return "eager singleton"; |
| 305 | } |
| 306 | }; |
| 307 | } |
| 308 | |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 309 | static final String IMPLEMENTATION_ALREADY_SET |
| 310 | = "Implementation is set more than once."; |
| 311 | static final String SINGLE_INSTANCE_AND_SCOPE = "Setting the scope is not" |
| 312 | + " permitted when binding to a single instance."; |
| 313 | static final String SCOPE_ALREADY_SET = "Scope is set more than once."; |
| 314 | static final String ANNOTATION_ALREADY_SPECIFIED = "More than one annotation" |
| 315 | + " is specified for this binding."; |
| 316 | |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 317 | private void checkNotTargetted() { |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 318 | if (bindTarget != EMPTY_BIND_TARGET) { |
| 319 | binder.addError(IMPLEMENTATION_ALREADY_SET); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 320 | } |
| 321 | } |
| 322 | |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 323 | private void checkNotAnnotated() { |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 324 | if (BindCommand.this.key.getAnnotationType() != null) { |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 325 | binder.addError(ANNOTATION_ALREADY_SPECIFIED); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 326 | } |
| 327 | } |
| 328 | |
limpbizkit | 7f8eda0 | 2008-03-26 01:11:16 +0000 | [diff] [blame] | 329 | private void checkNotScoped() { |
limpbizkit | 3d58d6b | 2008-03-08 16:11:47 +0000 | [diff] [blame] | 330 | // Scoping isn't allowed when we have only one instance. |
| 331 | if (bindTarget.get() != null) { |
| 332 | binder.addError(SINGLE_INSTANCE_AND_SCOPE); |
| 333 | return; |
| 334 | } |
| 335 | |
| 336 | if (bindScoping != EMPTY_SCOPING) { |
| 337 | binder.addError(SCOPE_ALREADY_SET); |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 338 | } |
| 339 | } |
limpbizkit | d6967b9 | 2008-05-16 15:28:51 +0000 | [diff] [blame^] | 340 | |
| 341 | @Override public String toString() { |
| 342 | String type = key.getAnnotationType() == null |
| 343 | ? "AnnotatedBindingBuilder<" |
| 344 | : "LinkedBindingBuilder<"; |
| 345 | return type + key.getTypeLiteral() + ">"; |
| 346 | } |
limpbizkit | a67e39f | 2008-02-18 20:10:59 +0000 | [diff] [blame] | 347 | } |
| 348 | } |