-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
Identity.java
99 lines (93 loc) · 3.08 KB
/
Identity.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
/*
* This file is part of adventure, licensed under the MIT License.
*
* Copyright (c) 2017-2021 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.identity;
import java.util.UUID;
import java.util.stream.Stream;
import net.kyori.adventure.Adventure;
import net.kyori.adventure.key.Key;
import net.kyori.adventure.pointer.Pointer;
import net.kyori.adventure.text.Component;
import net.kyori.examination.Examinable;
import net.kyori.examination.ExaminableProperty;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
* An identity used to track the sender of messages for the social interaction features
* introduced in <em>Minecraft: Java Edition</em> 1.16.4.
*
* @since 4.0.0
* @sinceMinecraft 1.16
*/
public interface Identity extends Examinable {
/**
* A pointer to a name.
*
* @since 4.8.0
*/
Pointer<String> NAME = Pointer.pointer(String.class, Key.key(Adventure.NAMESPACE, "name"));
/**
* A pointer to a {@link UUID}.
*
* @since 4.8.0
*/
Pointer<UUID> UUID = Pointer.pointer(UUID.class, Key.key(Adventure.NAMESPACE, "uuid"));
/**
* A pointer to a display name.
*
* @since 4.8.0
*/
Pointer<Component> DISPLAY_NAME = Pointer.pointer(Component.class, Key.key(Adventure.NAMESPACE, "display_name"));
/**
* Gets the {@code null} identity.
*
* <p>This should only be used when no players can be linked to a message.</p>
*
* @return the {@code null} identity
* @since 4.0.0
*/
static @NonNull Identity nil() {
return Identities.NIL;
}
/**
* Creates an identity.
*
* @param uuid the uuid
* @return an identity
* @since 4.0.0
*/
static @NonNull Identity identity(final @NonNull UUID uuid) {
if(uuid.equals(Identities.NIL.uuid())) return Identities.NIL;
return new IdentityImpl(uuid);
}
/**
* Gets the uuid.
*
* @return the uuid
* @since 4.0.0
*/
@NonNull UUID uuid();
@Override
default @NonNull Stream<? extends ExaminableProperty> examinableProperties() {
return Stream.of(ExaminableProperty.of("uuid", this.uuid()));
}
}