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
17package com.google.inject.spi;
18
19import com.google.inject.Binding;
20import com.google.inject.Key;
21
22import java.util.Set;
23
24/**
25 * A binding created from converting a bound instance to a new type. The source binding has the same
26 * binding annotation but a different type.
27 *
28 * @author jessewilson@google.com (Jesse Wilson)
29 * @since 2.0
30 */
31public interface ConvertedConstantBinding<T> extends Binding<T>, HasDependencies {
32
33  /**
34   * Returns the converted value.
35   */
36  T getValue();
37
38  /**
39   * Returns the type converter binding used to convert the constant.
40   *
41   * @since 3.0
42   */
43  TypeConverterBinding getTypeConverterBinding();
44
45  /**
46   * Returns the key for the source binding. That binding can be retrieved from an injector using
47   * {@link com.google.inject.Injector#getBinding(Key) Injector.getBinding(key)}.
48   */
49  Key<String> getSourceKey();
50
51  /**
52   * Returns a singleton set containing only the converted key.
53   */
54  Set<Dependency<?>> getDependencies();
55}
56