-
-
Notifications
You must be signed in to change notification settings - Fork 101
/
TriState.java
130 lines (123 loc) · 4.17 KB
/
TriState.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
/*
* 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.util;
import java.util.function.BooleanSupplier;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Similar to a {@code boolean} but with three states.
*
* @since 4.8.0
*/
public enum TriState {
/**
* State describing the absence of a value.
*
* @since 4.8.0
*/
NOT_SET,
/**
* State describing a {@code false} value.
*
* @since 4.8.0
*/
FALSE,
/**
* State describing a {@code true} value.
*
* @since 4.8.0
*/
TRUE;
/**
* Converts this tri-state back into a {@link Boolean}.
*
* @return the boolean representing this tri-state. {@link #NOT_SET} will be represented by {@code null}.
* @since 4.10.0
*/
public @Nullable Boolean toBoolean() {
switch (this) {
case TRUE: return Boolean.TRUE;
case FALSE: return Boolean.FALSE;
default: return null;
}
}
/**
* Converts this tri-state back into a {@code boolean}.
*
* <p>As the {@link #NOT_SET} state cannot be represented by the boolean type, this
* method maps the {@link #NOT_SET} state to other passed boolean value.
* This method may hence also be viewed as an equivalent to {@link
* java.util.Optional#orElse(Object)}.</p>
*
* @param other the boolean value that should be returned if this tri-state is {@link #NOT_SET}.
* @return the boolean representing the tri-state or the boolean passed if this state is {@link #NOT_SET}.
* @since 4.10.0
*/
public boolean toBooleanOrElse(final boolean other) {
switch (this) {
case TRUE: return true;
case FALSE: return false;
default: return other;
}
}
/**
* Converts this tri-state back into a {@code boolean}.
*
* <p>As the {@link #NOT_SET} state cannot be represented by the boolean type, this
* method maps the {@link #NOT_SET} state to the suppliers result.
* This method may hence also be viewed as an equivalent to {@link
* java.util.Optional#orElseGet(java.util.function.Supplier)}.</p>
*
* @param supplier the supplier that will be executed to produce the value that should be returned if this tri-state is {@link #NOT_SET}.
* @return the boolean representing the tri-state or the result of the passed supplier if this state is {@link #NOT_SET}.
* @since 4.10.0
*/
public boolean toBooleanOrElseGet(final @NotNull BooleanSupplier supplier) {
switch (this) {
case TRUE: return true;
case FALSE: return false;
default: return supplier.getAsBoolean();
}
}
/**
* Gets a state from a {@code boolean}.
*
* @param value the boolean
* @return a tri-state
* @since 4.8.0
*/
public static @NotNull TriState byBoolean(final boolean value) {
return value ? TRUE : FALSE;
}
/**
* Gets a state from a {@link Boolean}.
*
* @param value the boolean
* @return a tri-state
* @since 4.8.0
*/
public static @NotNull TriState byBoolean(final @Nullable Boolean value) {
return value == null ? NOT_SET : byBoolean(value.booleanValue());
}
}