xref: /aosp_15_r20/external/dagger2/java/dagger/multibindings/LongKey.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)
1*f585d8a3SJacky Wang /*
2*f585d8a3SJacky Wang  * Copyright (C) 2015 The Dagger Authors.
3*f585d8a3SJacky Wang  *
4*f585d8a3SJacky Wang  * Licensed under the Apache License, Version 2.0 (the "License");
5*f585d8a3SJacky Wang  * you may not use this file except in compliance with the License.
6*f585d8a3SJacky Wang  * You may obtain a copy of the License at
7*f585d8a3SJacky Wang  *
8*f585d8a3SJacky Wang  * http://www.apache.org/licenses/LICENSE-2.0
9*f585d8a3SJacky Wang  *
10*f585d8a3SJacky Wang  * Unless required by applicable law or agreed to in writing, software
11*f585d8a3SJacky Wang  * distributed under the License is distributed on an "AS IS" BASIS,
12*f585d8a3SJacky Wang  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*f585d8a3SJacky Wang  * See the License for the specific language governing permissions and
14*f585d8a3SJacky Wang  * limitations under the License.
15*f585d8a3SJacky Wang  */
16*f585d8a3SJacky Wang 
17*f585d8a3SJacky Wang package dagger.multibindings;
18*f585d8a3SJacky Wang 
19*f585d8a3SJacky Wang import static java.lang.annotation.RetentionPolicy.RUNTIME;
20*f585d8a3SJacky Wang 
21*f585d8a3SJacky Wang import dagger.MapKey;
22*f585d8a3SJacky Wang import java.lang.annotation.Documented;
23*f585d8a3SJacky Wang import java.lang.annotation.ElementType;
24*f585d8a3SJacky Wang import java.lang.annotation.Retention;
25*f585d8a3SJacky Wang import java.lang.annotation.Target;
26*f585d8a3SJacky Wang 
27*f585d8a3SJacky Wang /** A {@link MapKey} annotation for maps with {@code long} keys. */
28*f585d8a3SJacky Wang @Documented
29*f585d8a3SJacky Wang // While METHOD is the only valid target for Dagger, FIELD was added to support Hilt's
30*f585d8a3SJacky Wang // @BindValueIntoMap and TYPE was added to support external extension types since it likely won't
31*f585d8a3SJacky Wang // cause confusion/maintenance issues as this isn't part of Dagger's core API.
32*f585d8a3SJacky Wang // See discussion on https://github.com/google/dagger/pull/2831#issuecomment-919417457 for details.
33*f585d8a3SJacky Wang @Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
34*f585d8a3SJacky Wang @Retention(RUNTIME)
35*f585d8a3SJacky Wang @MapKey
36*f585d8a3SJacky Wang public @interface LongKey {
value()37*f585d8a3SJacky Wang   long value();
38*f585d8a3SJacky Wang }
39