me.moros.bending.api.util.KeyUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bending-api Show documentation
Modern Bending api for Minecraft
The newest version!
/*
 * Copyright 2020-2024 Moros
 *
 * This file is part of Bending.
 *
 * Bending is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Bending is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Bending. If not, see .
 */

package me.moros.bending.api.util;

import java.util.function.Function;

import me.moros.bending.api.util.data.DataKey;
import net.kyori.adventure.key.Key;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Utility class for keys.
 */
@SuppressWarnings("PatternValidation")
public final class KeyUtil {
  public static final String BENDING_NAMESPACE = "bending";
  public static final Function BENDING_KEY_MAPPER = stringToKey(BENDING_NAMESPACE);
  public static final Function VANILLA_KEY_MAPPER = stringToKey(Key.MINECRAFT_NAMESPACE);

  private KeyUtil() {
  }

  /**
   * Create a mapper function that converts a string to a key using the provided namespace.
   * @param namespace the namespace to use
   * @return the mapper function
   */
  public static Function stringToKey(String namespace) {
    if (!Key.parseableNamespace(namespace)) {
      throw new IllegalArgumentException("Invalid namespace %s!".formatted(namespace));
    }
    return input -> fromString(input, namespace);
  }

  /**
   * Create a key using the vanilla ({@value Key#MINECRAFT_NAMESPACE}) namespace.
   * @param value the value of the key.
   * @return the created key
   */
  public static Key vanilla(String value) {
    return Key.key(Key.MINECRAFT_NAMESPACE, value);
  }

  /**
   * Create a key using the bending ({@value #BENDING_NAMESPACE}) namespace.
   * @param value the value of the key
   * @return the created key
   */
  public static Key simple(String value) {
    return Key.key(BENDING_NAMESPACE, value);
  }

  /**
   * Create a bending data key.
   * @param value the value to include in the data key.
   * @param type the class type of the value
   * @param  the type of the value
   * @return the created data key
   */
  public static  DataKey data(String value, Class type) {
    return DataKey.wrap(Key.key(BENDING_NAMESPACE, value), type);
  }

  /**
   * Concatenates a key's namespace and value, separated by a period.
   * @param key the key to use
   * @return the resulting string
   */
  public static String concat(Key key) {
    return key.namespace() + '.' + key.value();
  }

  private static @Nullable Key fromString(String string, String defNamespace) {
    int index = string.indexOf(Key.DEFAULT_SEPARATOR);
    String namespace = index >= 1 ? string.substring(0, index) : defNamespace;
    String value = index >= 0 ? string.substring(index + 1) : string;
    if ((namespace.equals(defNamespace) || Key.parseableNamespace(namespace)) && Key.parseableValue(value)) {
      return Key.key(namespace, value);
    }
    return null;
  }
}