-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
ComponentSerializer.java
136 lines (126 loc) · 4.78 KB
/
ComponentSerializer.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
/*
* 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.text.serializer;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.checker.nullness.qual.PolyNull;
import org.jetbrains.annotations.Contract;
/**
* A {@link Component} serializer and deserializer.
*
* @param <I> the input component type
* @param <O> the output component type
* @param <R> the serialized type
* @since 4.0.0
*/
public interface ComponentSerializer<I extends Component, O extends Component, R> {
/**
* Deserialize a component from input of type {@code R}.
*
* @param input the input
* @return the component
* @since 4.0.0
*/
@NonNull O deserialize(final @NonNull R input);
/**
* Deserialize a component from input of type {@code R}.
*
* <p>If {@code input} is {@code null}, then {@code null} will be returned.</p>
*
* @param input the input
* @return the component if {@code input} is non-null, otherwise {@code null}
* @since 4.7.0
* @deprecated Use the correctly spelt {@link #deserializeOrNull(Object)}.
*/
@Deprecated
@Contract(value = "!null -> !null; null -> null", pure = true)
default @PolyNull O deseializeOrNull(final @PolyNull R input) {
return this.deserializeOrNull(input);
}
/**
* Deserialize a component from input of type {@code R}.
*
* <p>If {@code input} is {@code null}, then {@code null} will be returned.</p>
*
* @param input the input
* @return the component if {@code input} is non-null, otherwise {@code null}
* @since 4.8.0
*/
@Contract(value = "!null -> !null; null -> null", pure = true)
default @PolyNull O deserializeOrNull(final @PolyNull R input) {
return this.deserializeOr(input, null);
}
/**
* Deserialize a component from input of type {@code R}.
*
* <p>If {@code input} is {@code null}, then {@code fallback} will be returned.</p>
*
* @param input the input
* @param fallback the fallback value
* @return the component if {@code input} is non-null, otherwise {@code fallback}
* @since 4.7.0
*/
@Contract(value = "!null, _ -> !null; null, _ -> param2", pure = true)
default @PolyNull O deserializeOr(final @Nullable R input, final @PolyNull O fallback) {
if(input == null) return fallback;
return this.deserialize(input);
}
/**
* Serializes a component into an output of type {@code R}.
*
* @param component the component
* @return the output
* @since 4.0.0
*/
@NonNull R serialize(final @NonNull I component);
/**
* Serializes a component into an output of type {@code R}.
*
* <p>If {@code component} is {@code null}, then {@code null} will be returned.</p>
*
* @param component the component
* @return the output if {@code component} is non-null, otherwise {@code null}
* @since 4.7.0
*/
@Contract(value = "!null -> !null; null -> null", pure = true)
default @PolyNull R serializeOrNull(final @PolyNull I component) {
return this.serializeOr(component, null);
}
/**
* Serializes a component into an output of type {@code R}.
*
* <p>If {@code component} is {@code null}, then {@code fallback} will be returned.</p>
*
* @param component the component
* @param fallback the fallback value
* @return the output if {@code component} is non-null, otherwise {@code fallback}
* @since 4.7.0
*/
@Contract(value = "!null, _ -> !null; null, _ -> param2", pure = true)
default @PolyNull R serializeOr(final @Nullable I component, final @PolyNull R fallback) {
if(component == null) return fallback;
return this.serialize(component);
}
}