-
-
Notifications
You must be signed in to change notification settings - Fork 102
/
Key.java
181 lines (169 loc) · 6.19 KB
/
Key.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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/*
* This file is part of adventure, licensed under the MIT License.
*
* Copyright (c) 2017-2022 KyoriPowered
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.kyori.adventure.key;
import java.util.Comparator;
import java.util.stream.Stream;
import net.kyori.examination.Examinable;
import net.kyori.examination.ExaminableProperty;
import org.intellij.lang.annotations.Pattern;
import org.jetbrains.annotations.NotNull;
/**
* An identifying object used to fetch and/or store unique objects.
*
* <p>A key consists of:</p>
* <dl>
* <dt>namespace</dt>
* <dd>in most cases this should be your plugin or organization name</dd>
* <dt>value</dt>
* <dd>what this key leads to, e.g "translations" or "entity.firework_rocket.blast"</dd>
* </dl>
*
* <p>Valid characters for namespaces are <a href="https://regexr.com/5ibbm">{@code [a-z0-9_.-]}</a>.</p>
*
* <p>Valid characters for values are <a href="https://regexr.com/5if3m">{@code [a-z0-9/._-]}</a>.</p>
*
* <p>Some examples of possible custom keys:</p>
* <ul>
* <li> my_plugin:translations</li>
* <li> my_plugin:weapon.amazing-weapon_damage-attribute</li>
* <li> my_organization:music.song_1</li>
* <li> my_organization:item.magic_button</li>
* </ul>
*
* @since 4.0.0
*/
public interface Key extends Comparable<Key>, Examinable, Namespaced {
/**
* The namespace for Minecraft.
*
* @since 4.0.0
*/
String MINECRAFT_NAMESPACE = "minecraft";
/**
* Creates a key.
*
* <p>This will parse {@code string} as a key, using {@code :} as a separator between the namespace and the value.</p>
*
* <p>The namespace is optional. If you do not provide one (for example, if you provide just {@code player} or {@code :player}
* as the string) then {@link #MINECRAFT_NAMESPACE} will be used as a namespace and {@code string} will be used as the value,
* removing the colon if necessary.</p>
*
* @param string the string
* @return the key
* @throws InvalidKeyException if the namespace or value contains an invalid character
* @since 4.0.0
*/
static @NotNull Key key(final @NotNull @Pattern("(" + KeyImpl.NAMESPACE_PATTERN + ":)?" + KeyImpl.VALUE_PATTERN) String string) {
return key(string, ':');
}
/**
* Creates a key.
*
* <p>This will parse {@code string} as a key, using {@code character} as a separator between the namespace and the value.</p>
*
* <p>The namespace is optional. If you do not provide one (for example, if you provide {@code player} or {@code character + "player"}
* as the string) then {@link #MINECRAFT_NAMESPACE} will be used as a namespace and {@code string} will be used as the value,
* removing the provided separator character if necessary.</p>
*
* @param string the string
* @param character the character that separates the namespace from the value
* @return the key
* @throws InvalidKeyException if the namespace or value contains an invalid character
* @since 4.0.0
*/
@SuppressWarnings("PatternValidation") // impossible to validate since the character is variable
static @NotNull Key key(final @NotNull String string, final char character) {
final int index = string.indexOf(character);
final String namespace = index >= 1 ? string.substring(0, index) : MINECRAFT_NAMESPACE;
final String value = index >= 0 ? string.substring(index + 1) : string;
return key(namespace, value);
}
/**
* Creates a key.
*
* @param namespaced the namespace source
* @param value the value
* @return the key
* @throws InvalidKeyException if the namespace or value contains an invalid character
* @since 4.4.0
*/
static @NotNull Key key(final @NotNull Namespaced namespaced, final @NotNull @Pattern(KeyImpl.VALUE_PATTERN) String value) {
return key(namespaced.namespace(), value);
}
/**
* Creates a key.
*
* @param namespace the namespace
* @param value the value
* @return the key
* @throws InvalidKeyException if the namespace or value contains an invalid character
* @since 4.0.0
*/
static @NotNull Key key(final @NotNull @Pattern(KeyImpl.NAMESPACE_PATTERN) String namespace, final @NotNull @Pattern(KeyImpl.VALUE_PATTERN) String value) {
return new KeyImpl(namespace, value);
}
/**
* Gets the comparator.
*
* <p>The {@link #value() value} is compared first, followed by the {@link #namespace() namespace}.</p>
*
* @return a comparator for keys
* @since 4.10.0
*/
static @NotNull Comparator<? super Key> comparator() {
return KeyImpl.COMPARATOR;
}
/**
* Gets the namespace.
*
* @return the namespace
* @since 4.0.0
*/
@NotNull String namespace();
/**
* Gets the value.
*
* @return the value
* @since 4.0.0
*/
@NotNull String value();
/**
* Returns the string representation of this key.
*
* @return the string representation
* @since 4.0.0
*/
@NotNull String asString();
@Override
default @NotNull Stream<? extends ExaminableProperty> examinableProperties() {
return Stream.of(
ExaminableProperty.of("namespace", this.namespace()),
ExaminableProperty.of("value", this.value())
);
}
@Override
default int compareTo(final @NotNull Key that) {
return comparator().compare(this, that);
}
}