Package cloud.commandframework.keys

Interface CloudKey<T>

Type Parameters:
T - The type of the key
All Known Subinterfaces:
CommandMeta.Key<V>
All Known Implementing Classes:
SimpleCloudKey
public interface CloudKey<T>
A typed, named key
Since:
1.4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    getName()
    Get the name of the key.
    @NonNull io.leangen.geantyref.TypeToken<@NonNull T>
    getType()
    Get the type of the value that this key holds.

  • Method Details

    • getName

      @NonNull String getName()
      Get the name of the key. The name of the key should be used to determine key equality. That means that two keys sharing the same name are equal.
      Returns:
      The key name

    • getType

      @NonNull io.leangen.geantyref.TypeToken<@NonNull T> getType()
      Get the type of the value that this key holds.
      Returns:
      The type of the key value.