/
RegistryType.java
71 lines (68 loc) · 2.46 KB
/
RegistryType.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
**********************************************************************
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
**********************************************************************/
package org.eclipse.microprofile.metrics.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.eclipse.microprofile.metrics.MetricRegistry;
/**
* The scope of Metric Registry to inject.
* <p>
* This can be used to obtain the respective scoped {@link MetricRegistry}:
* </p>
*
* <pre>
* <code>
* {@literal @}Inject
* {@literal @}RegistryType(scope=MetricRegistry.APPLICATION_SCOPE)
* MetricRegistry appRegistry;
*
* {@literal @}Inject
* {@literal @}RegistryType(scope="customScope")
* MetricRegistry customRegistry;
*
* </code>
* </pre>
*
* see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
* {@link MetricRegistry.VENDOR_SCOPE}
*
* @author Raymond Lam
*
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
public @interface RegistryType {
/**
* The scope of the MetricRegistry.
*
* @return Returns or creates the scope of the MetricRegistry. The MicroProfile runtimes provides
* {@code application}, {@code base} and {@code vendor} scopes as part of the runtime.
*
* see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
* {@link MetricRegistry.VENDOR_SCOPE}
*/
String scope() default MetricRegistry.APPLICATION_SCOPE;
}