forked from micrometer-metrics/micrometer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
KeyValue.java
107 lines (93 loc) · 3.2 KB
/
KeyValue.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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
* Copyright 2017 VMware, Inc.
*
* 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
*
* https://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.
*/
package io.micrometer.common;
import java.util.function.Predicate;
import io.micrometer.common.docs.KeyName;
/**
* Key/value pair representing a dimension of a meter used to classify and drill into
* measurements.
*
* @author Jon Schneider
* @since 1.10.0
*/
public interface KeyValue extends Comparable<KeyValue> {
/**
* Use this if you want to indicate that the value is missing.
*/
String NONE_VALUE = "none";
String getKey();
String getValue();
/**
* Creates a {@link KeyValue} for the given key and value.
* @param key key of the KeyValue
* @param value value for key
* @return KeyValue
*/
static KeyValue of(String key, String value) {
return new ImmutableKeyValue(key, value);
}
/**
* Creates a {@link KeyValue} for the given {@link KeyName} and value.
* @param keyName name of the key of the KeyValue
* @param value value for key
* @return KeyValue
*/
static KeyValue of(KeyName keyName, String value) {
return KeyValue.of(keyName.asString(), value);
}
/**
* Creates a {@link KeyValue} for the given key and {@value NONE_VALUE}.
* @param key key of the KeyValue
* @return KeyValue
*/
static KeyValue of(String key) {
return of(key, NONE_VALUE);
}
/**
* Creates a {@link KeyValue} for the given {@link KeyName} and {@value NONE_VALUE}.
* @param keyName name of the key of the KeyValue
* @return KeyValue
*/
static KeyValue of(KeyName keyName) {
return of(keyName, NONE_VALUE);
}
/**
* Creates a {@link KeyValue} for the given key and value and additionally validates
* it with the {@link Predicate}.
* @param key key of the KeyValue
* @param value value for key
* @param validator the {@link Predicate} used for validating the value
* @return KeyValue
*/
static <T> KeyValue of(String key, T value, Predicate<? super T> validator) {
return new ValidatedKeyValue<>(key, value, validator);
}
/**
* Creates a {@link KeyValue} for the given {@link KeyName} and value and additionally
* validates it with the {@link Predicate}.
* @param keyName name of the key of the KeyValue
* @param value value for key
* @param validator the {@link Predicate} used for validating the value
* @return KeyValue
*/
static <T> KeyValue of(KeyName keyName, T value, Predicate<? super T> validator) {
return KeyValue.of(keyName.asString(), value, validator);
}
@Override
default int compareTo(KeyValue o) {
return getKey().compareTo(o.getKey());
}
}