Package cn.lunadeer.dominion.api.dtos.flag

Class Flag

java.lang.Object
cn.lunadeer.dominion.api.dtos.flag.Flag
Direct Known Subclasses:
EnvFlag, PriFlag
public abstract class Flag extends Object
Represents a flag in the Dominion system. This abstract class provides the basic structure and methods for flags, including their name, display name, description, default value, and enable status.

  • Constructor Details

    • Flag

      public Flag(@NotNull @NotNull String flag_name, @NotNull @NotNull String display_name, @NotNull @NotNull String description, @NotNull @NotNull Boolean default_value, @NotNull @NotNull Boolean enable)
      Constructs a new Flag with the specified parameters.
      Parameters:
      flag_name - the name of the flag
      display_name - the display name of the flag
      description - the description of the flag
      default_value - the default value of the flag
      enable - the enable status of the flag

  • Method Details

    • getFlagName

      @NotNull public @NotNull String getFlagName()
      Returns the name of the flag.
      Returns:
      the name of the flag

    • getDisplayName

      @NotNull public @NotNull String getDisplayName()
      Returns the display name of the flag. This is the name that will be displayed to the user. Can be translated in language files.
      Returns:
      the display name of the flag

    • getDescription

      @NotNull public @NotNull String getDescription()
      Returns the description of the flag. Can be translated in language files.
      Returns:
      the description of the flag

    • getDefaultValue

      @NotNull public @NotNull Boolean getDefaultValue()
      Returns the default value of the flag.
      Returns:
      the default value of the flag

    • getEnable

      @NotNull public @NotNull Boolean getEnable()
      Returns the enable status of the flag.
      Returns:
      the enable status of the flag

    • setDisplayName

      public void setDisplayName(String displayName)
      Sets the display name of the flag.
      Parameters:
      displayName - the new display name of the flag

    • setDescription

      public void setDescription(String description)
      Sets the description of the flag.
      Parameters:
      description - the new description of the flag

    • setDefaultValue

      public void setDefaultValue(Boolean defaultValue)
      Sets the default value of the flag.
      Parameters:
      defaultValue - the new default value of the flag

    • setEnable

      public void setEnable(Boolean enable)
      Sets the enable status of the flag.
      Parameters:
      enable - the new enable status of the flag

    • getDisplayNameKey

      public String getDisplayNameKey()
      Returns the configuration key for the display name of the flag.
      Returns:
      the configuration key for the display name

    • getDescriptionKey

      public String getDescriptionKey()
      Returns the configuration key for the description of the flag.
      Returns:
      the configuration key for the description

    • getConfigurationDescKey

      public abstract String getConfigurationDescKey()
      Returns the configuration key for the description of this flag.
      Returns:
      the configuration key for the description

    • getConfigurationDefaultKey

      public abstract String getConfigurationDefaultKey()
      Returns the configuration key for the default value of this flag.
      Returns:
      the configuration key for the default value

    • getConfigurationEnableKey

      public abstract String getConfigurationEnableKey()
      Returns the configuration key for the enable status of this flag.
      Returns:
      the configuration key for the enable status

    • getConfigurationNameKey

      public abstract String getConfigurationNameKey()
      Returns the configuration key for the name of this flag.
      Returns:
      the configuration key for the name