Package cloud.commandframework.captions

Class CaptionVariable

  • public final class CaptionVariable
extends java.lang.Object
    Key-value pair used to replace variables in captions

    • Method Summary

      Modifier and Type Method Description
      @NonNull java.lang.String getKey()
      Get the variable key
      @NonNull java.lang.String getValue()
      Get the variable value
      static @NonNull CaptionVariable of​(@NonNull java.lang.String key, @NonNull java.lang.String value)
      Create a new caption variable instance

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • of

        public static @NonNull CaptionVariable of​(@NonNull java.lang.String key,
                                          @NonNull java.lang.String value)
        Create a new caption variable instance
        Parameters:
        key - Key
        value - Replacement
        Returns:
        Created instance

      • getKey

        public @NonNull java.lang.String getKey()
        Get the variable key
        Returns:
        Key

      • getValue

        public @NonNull java.lang.String getValue()
        Get the variable value
        Returns:
        Value