net.kyori.text.serializer.LegacyComponentSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of text Show documentation
A text library for Minecraft.
There is a newer version: 1.12-1.6.5
/*
 * This file is part of text, licensed under the MIT License.
 *
 * Copyright (c) 2017 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.text.serializer;

import com.google.common.annotations.VisibleForTesting;
import net.kyori.text.Component;
import net.kyori.text.TextComponent;

import javax.annotation.Nonnull;

/**
 * A legacy component serializer.
 *
 * @deprecated legacy
 */
@Deprecated
public interface LegacyComponentSerializer extends ComponentSerializer {

  /**
   * The legacy character.
   *
   * @deprecated legacy
   */
  @Deprecated
  @VisibleForTesting
  char CHARACTER = '\u00A7';

  /**
   * Deserialize a component from a {@link String} with the {@link #CHARACTER legacy character}.
   *
   * @param input the input
   * @return the component
   * @deprecated legacy
   */
  @Deprecated
  @Nonnull
  @Override
  default TextComponent deserialize(@Nonnull final String input) {
    return this.deserialize(input, CHARACTER);
  }

  /**
   * Deserialize a component from a {@link String} with the specified {@code character legacy character}.
   *
   * @param input the input
   * @param character the legacy character
   * @return the component
   * @deprecated legacy
   */
  @Deprecated
  @Nonnull
  TextComponent deserialize(@Nonnull final String input, final char character);

  /**
   * Serializes a component into a {@link String} with the specified {@link #CHARACTER legacy character}.
   *
   * @param component the component
   * @return the string
   * @deprecated legacy
   */
  @Deprecated
  @Nonnull
  @Override
  default String serialize(@Nonnull final Component component) {
    return this.serialize(component, CHARACTER);
  }

  /**
   * Serializes a component into a {@link String} with the specified {@code character legacy character}.
   *
   * @param component the component
   * @param character the legacy character
   * @return the string
   * @deprecated legacy
   */
  @Deprecated
  @Nonnull
  String serialize(@Nonnull final Component component, final char character);
}