-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
TextDecoration.java
170 lines (156 loc) · 4.25 KB
/
TextDecoration.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
/*
* 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.format;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.util.Index;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* An enumeration of decorations which may be applied to a {@link Component}.
*
* @since 4.0.0
*/
public enum TextDecoration implements StyleBuilderApplicable, TextFormat {
/**
* A decoration which makes text obfuscated/unreadable.
*
* @since 4.0.0
*/
OBFUSCATED("obfuscated"),
/**
* A decoration which makes text appear bold.
*
* @since 4.0.0
*/
BOLD("bold"),
/**
* A decoration which makes text have a strike through it.
*
* @since 4.0.0
*/
STRIKETHROUGH("strikethrough"),
/**
* A decoration which makes text have an underline.
*
* @since 4.0.0
*/
UNDERLINED("underlined"),
/**
* A decoration which makes text appear in italics.
*
* @since 4.0.0
*/
ITALIC("italic");
/**
* The name map.
*
* @since 4.0.0
*/
public static final Index<String, TextDecoration> NAMES = Index.create(TextDecoration.class, constant -> constant.name);
private final String name;
TextDecoration(final String name) {
this.name = name;
}
/**
* Creates a {@link TextDecorationAndState}.
*
* @param state the state
* @return a {@link TextDecorationAndState}
* @since 4.8.0
*/
public final @NotNull TextDecorationAndState as(final boolean state) {
return this.as(State.byBoolean(state));
}
/**
* Creates a {@link TextDecorationAndState}.
*
* @param state the state
* @return a {@link TextDecorationAndState}
* @since 4.8.0
*/
public final @NotNull TextDecorationAndState as(final @NotNull State state) {
return new TextDecorationAndStateImpl(this, state);
}
@Override
public void styleApply(final Style.@NotNull Builder style) {
style.decorate(this);
}
@Override
public @NotNull String toString() {
return this.name;
}
/**
* A state that a {@link TextDecoration} can be in.
*
* @since 4.0.0
*/
public enum State {
/**
* State describing the absence of a value.
*
* @since 4.0.0
*/
NOT_SET("not_set"),
/**
* State describing a {@code false} value.
*
* @since 4.0.0
*/
FALSE("false"),
/**
* State describing a {@code true} value.
*
* @since 4.0.0
*/
TRUE("true");
private final String name;
State(final String name) {
this.name = name;
}
@Override
public String toString() {
return this.name;
}
/**
* Gets a state from a {@code boolean}.
*
* @param flag the boolean
* @return the state
* @since 4.0.0
*/
public static @NotNull State byBoolean(final boolean flag) {
return flag ? TRUE : FALSE;
}
/**
* Gets a state from a {@code Boolean}.
*
* @param flag the boolean
* @return the state
* @since 4.0.0
*/
public static @NotNull State byBoolean(final @Nullable Boolean flag) {
return flag == null ? NOT_SET : byBoolean(flag.booleanValue());
}
}
}