-
-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(api): Support representing translation args losslessly
- Loading branch information
Showing
12 changed files
with
433 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
api/src/main/java/net/kyori/adventure/text/TranslationArgument.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /* | ||
| * This file is part of adventure, licensed under the MIT License. | ||
| * | ||
| * Copyright (c) 2017-2023 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; | ||
|
|
||
| import net.kyori.examination.Examinable; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| import static java.util.Objects.requireNonNull; | ||
|
|
||
| /** | ||
| * An argument that can be part of a {@link TranslatableComponent}. | ||
| * | ||
| * @since 4.15.0 | ||
| */ | ||
| @ApiStatus.NonExtendable | ||
| public interface TranslationArgument extends ComponentLike, Examinable { | ||
|
|
||
| /** | ||
| * The argument's value. | ||
| * | ||
| * @return the argument value | ||
| * @since 4.15.0 | ||
| */ | ||
| @NotNull Object value(); | ||
|
|
||
| /** | ||
| * Create a boolean argument. | ||
| * | ||
| * @param value the value | ||
| * @return the argument | ||
| * @since 4.15.0 | ||
| * @sinceMinecraft 1.20.3 | ||
| */ | ||
| static @NotNull TranslationArgument bool(final boolean value) { | ||
| return new TranslationArgumentImpl.BooleanImpl(value); | ||
| } | ||
|
|
||
| /** | ||
| * Create a numeric argument. | ||
| * | ||
| * @param value the value | ||
| * @return the argument | ||
| * @since 4.15.0 | ||
| * @sinceMinecraft 1.20.3 | ||
| */ | ||
| static @NotNull TranslationArgument numeric(final @NotNull Number value) { | ||
| return new TranslationArgumentImpl.NumericImpl(requireNonNull(value, "value")); | ||
| } | ||
|
|
||
| /** | ||
| * Create a component argument. | ||
| * | ||
| * @param value the value | ||
| * @return the argument | ||
| * @since 4.15.0 | ||
| * @sinceMinecraft 1.20.3 | ||
| */ | ||
| static @NotNull TranslationArgument component(final @NotNull ComponentLike value) { | ||
| return new TranslationArgumentImpl.ComponentImpl(requireNonNull(requireNonNull(value, "value").asComponent(), "value.asComponent()")); | ||
| } | ||
|
|
||
| /** | ||
| * A boolean argument to translations. | ||
| * | ||
| * @since 4.15.0 | ||
| * @sinceMinecraft 1.20.3 | ||
| */ | ||
| interface Boolean extends TranslationArgument { | ||
| /** | ||
| * The value of the argument. | ||
| * | ||
| * @return the raw argument value | ||
| * @since 4.15.0 | ||
| */ | ||
| java.lang.@NotNull Boolean value(); | ||
| } | ||
|
|
||
| /** | ||
| * A numeric argument to translations. | ||
| * | ||
| * @since 4.15.0 | ||
| * @sinceMinecraft 1.20.3 | ||
| */ | ||
| interface Numeric extends TranslationArgument { | ||
| /** | ||
| * The value of the argument. | ||
| * | ||
| * @return the raw argument value | ||
| * @since 4.15.0 | ||
| */ | ||
| @NotNull Number value(); | ||
| } | ||
|
|
||
| /** | ||
| * A component argument to translations. | ||
| * | ||
| * @since 4.15.0 | ||
| */ | ||
| interface Component extends TranslationArgument { | ||
| /** | ||
| * The value of the argument. | ||
| * | ||
| * @return the raw argument value | ||
| * @since 4.15.0 | ||
| */ | ||
| net.kyori.adventure.text.@NotNull Component value(); | ||
| } | ||
| } |
Oops, something went wrong.