Class SettingsDefinition.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<SettingsDefinition.Builder>
com.google.protobuf.GeneratedMessage.Builder<SettingsDefinition.Builder>
com.soulfiremc.grpc.generated.SettingsDefinition.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SettingsDefinitionOrBuilder, Cloneable
Enclosing class:
SettingsDefinition
public static final class SettingsDefinition.Builder extends com.google.protobuf.GeneratedMessage.Builder<SettingsDefinition.Builder> implements SettingsDefinitionOrBuilder
A complete setting definition that describes a single configurable value.
Contains all information needed for a client to render the setting UI,
validate input, and store/retrieve values by identifier.
Definitions are exported from the server and referenced by SettingsPage.
Protobuf type soulfire.v1.SettingsDefinition

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SettingsDefinition.Builder>

    • clear

      public SettingsDefinition.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SettingsDefinition.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SettingsDefinition.Builder>

    • getDefaultInstanceForType

      public SettingsDefinition getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SettingsDefinition build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SettingsDefinition buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SettingsDefinition.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SettingsDefinition.Builder>

    • mergeFrom

      public SettingsDefinition.Builder mergeFrom(SettingsDefinition other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SettingsDefinition.Builder>

    • mergeFrom

      public SettingsDefinition.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SettingsDefinition.Builder>
      Throws:
      IOException

    • getTypeCase

      public SettingsDefinition.TypeCase getTypeCase()
      Specified by:
      getTypeCase in interface SettingsDefinitionOrBuilder

    • clearType

      public SettingsDefinition.Builder clearType()

    • hasId

      public boolean hasId()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;
      Specified by:
      hasId in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public SettingsEntryIdentifier getId()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;
      Specified by:
      getId in interface SettingsDefinitionOrBuilder
      Returns:
      The id.

    • setId

      public SettingsDefinition.Builder setId(SettingsEntryIdentifier value)
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;

    • setId

      public SettingsDefinition.Builder setId(SettingsEntryIdentifier.Builder builderForValue)
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;

    • mergeId

      public SettingsDefinition.Builder mergeId(SettingsEntryIdentifier value)
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;

    • clearId

      public SettingsDefinition.Builder clearId()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;

    • getIdBuilder

      public SettingsEntryIdentifier.Builder getIdBuilder()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;

    • getIdOrBuilder

      public SettingsEntryIdentifierOrBuilder getIdOrBuilder()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;
      Specified by:
      getIdOrBuilder in interface SettingsDefinitionOrBuilder

    • getScopeValue

      public int getScopeValue()
      The configuration scope where this setting applies (SERVER, INSTANCE, BOT).
Determines where values are stored and how they cascade.
      .soulfire.v1.SettingsPageEntryScopeType scope = 2;
      Specified by:
      getScopeValue in interface SettingsDefinitionOrBuilder
      Returns:
      The enum numeric value on the wire for scope.

    • setScopeValue

      public SettingsDefinition.Builder setScopeValue(int value)
      The configuration scope where this setting applies (SERVER, INSTANCE, BOT).
Determines where values are stored and how they cascade.
      .soulfire.v1.SettingsPageEntryScopeType scope = 2;
      Parameters:
      value - The enum numeric value on the wire for scope to set.
      Returns:
      This builder for chaining.

    • getScope

      public SettingsPageEntryScopeType getScope()
      The configuration scope where this setting applies (SERVER, INSTANCE, BOT).
Determines where values are stored and how they cascade.
      .soulfire.v1.SettingsPageEntryScopeType scope = 2;
      Specified by:
      getScope in interface SettingsDefinitionOrBuilder
      Returns:
      The scope.

    • setScope

      public SettingsDefinition.Builder setScope(SettingsPageEntryScopeType value)
      The configuration scope where this setting applies (SERVER, INSTANCE, BOT).
Determines where values are stored and how they cascade.
      .soulfire.v1.SettingsPageEntryScopeType scope = 2;
      Parameters:
      value - The scope to set.
      Returns:
      This builder for chaining.

    • clearScope

      public SettingsDefinition.Builder clearScope()
      The configuration scope where this setting applies (SERVER, INSTANCE, BOT).
Determines where values are stored and how they cascade.
      .soulfire.v1.SettingsPageEntryScopeType scope = 2;
      Returns:
      This builder for chaining.

    • hasString

      public boolean hasString()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;
      Specified by:
      hasString in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the string field is set.

    • getString

      public StringSetting getString()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;
      Specified by:
      getString in interface SettingsDefinitionOrBuilder
      Returns:
      The string.

    • setString

      public SettingsDefinition.Builder setString(StringSetting value)
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;

    • setString

      public SettingsDefinition.Builder setString(StringSetting.Builder builderForValue)
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;

    • mergeString

      public SettingsDefinition.Builder mergeString(StringSetting value)
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;

    • clearString

      public SettingsDefinition.Builder clearString()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;

    • getStringBuilder

      public StringSetting.Builder getStringBuilder()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;

    • getStringOrBuilder

      public StringSettingOrBuilder getStringOrBuilder()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;
      Specified by:
      getStringOrBuilder in interface SettingsDefinitionOrBuilder

    • hasInt

      public boolean hasInt()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;
      Specified by:
      hasInt in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the int field is set.

    • getInt

      public IntSetting getInt()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;
      Specified by:
      getInt in interface SettingsDefinitionOrBuilder
      Returns:
      The int.

    • setInt

      public SettingsDefinition.Builder setInt(IntSetting value)
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;

    • setInt

      public SettingsDefinition.Builder setInt(IntSetting.Builder builderForValue)
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;

    • mergeInt

      public SettingsDefinition.Builder mergeInt(IntSetting value)
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;

    • clearInt

      public SettingsDefinition.Builder clearInt()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;

    • getIntBuilder

      public IntSetting.Builder getIntBuilder()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;

    • getIntOrBuilder

      public IntSettingOrBuilder getIntOrBuilder()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;
      Specified by:
      getIntOrBuilder in interface SettingsDefinitionOrBuilder

    • hasDouble

      public boolean hasDouble()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;
      Specified by:
      hasDouble in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the double field is set.

    • getDouble

      public DoubleSetting getDouble()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;
      Specified by:
      getDouble in interface SettingsDefinitionOrBuilder
      Returns:
      The double.

    • setDouble

      public SettingsDefinition.Builder setDouble(DoubleSetting value)
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;

    • setDouble

      public SettingsDefinition.Builder setDouble(DoubleSetting.Builder builderForValue)
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;

    • mergeDouble

      public SettingsDefinition.Builder mergeDouble(DoubleSetting value)
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;

    • clearDouble

      public SettingsDefinition.Builder clearDouble()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;

    • getDoubleBuilder

      public DoubleSetting.Builder getDoubleBuilder()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;

    • getDoubleOrBuilder

      public DoubleSettingOrBuilder getDoubleOrBuilder()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;
      Specified by:
      getDoubleOrBuilder in interface SettingsDefinitionOrBuilder

    • hasBool

      public boolean hasBool()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;
      Specified by:
      hasBool in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the bool field is set.

    • getBool

      public BoolSetting getBool()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;
      Specified by:
      getBool in interface SettingsDefinitionOrBuilder
      Returns:
      The bool.

    • setBool

      public SettingsDefinition.Builder setBool(BoolSetting value)
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;

    • setBool

      public SettingsDefinition.Builder setBool(BoolSetting.Builder builderForValue)
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;

    • mergeBool

      public SettingsDefinition.Builder mergeBool(BoolSetting value)
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;

    • clearBool

      public SettingsDefinition.Builder clearBool()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;

    • getBoolBuilder

      public BoolSetting.Builder getBoolBuilder()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;

    • getBoolOrBuilder

      public BoolSettingOrBuilder getBoolOrBuilder()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;
      Specified by:
      getBoolOrBuilder in interface SettingsDefinitionOrBuilder

    • hasCombo

      public boolean hasCombo()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;
      Specified by:
      hasCombo in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the combo field is set.

    • getCombo

      public ComboSetting getCombo()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;
      Specified by:
      getCombo in interface SettingsDefinitionOrBuilder
      Returns:
      The combo.

    • setCombo

      public SettingsDefinition.Builder setCombo(ComboSetting value)
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;

    • setCombo

      public SettingsDefinition.Builder setCombo(ComboSetting.Builder builderForValue)
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;

    • mergeCombo

      public SettingsDefinition.Builder mergeCombo(ComboSetting value)
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;

    • clearCombo

      public SettingsDefinition.Builder clearCombo()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;

    • getComboBuilder

      public ComboSetting.Builder getComboBuilder()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;

    • getComboOrBuilder

      public ComboSettingOrBuilder getComboOrBuilder()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;
      Specified by:
      getComboOrBuilder in interface SettingsDefinitionOrBuilder

    • hasStringList

      public boolean hasStringList()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;
      Specified by:
      hasStringList in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the stringList field is set.

    • getStringList

      public StringListSetting getStringList()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;
      Specified by:
      getStringList in interface SettingsDefinitionOrBuilder
      Returns:
      The stringList.

    • setStringList

      public SettingsDefinition.Builder setStringList(StringListSetting value)
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;

    • setStringList

      public SettingsDefinition.Builder setStringList(StringListSetting.Builder builderForValue)
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;

    • mergeStringList

      public SettingsDefinition.Builder mergeStringList(StringListSetting value)
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;

    • clearStringList

      public SettingsDefinition.Builder clearStringList()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;

    • getStringListBuilder

      public StringListSetting.Builder getStringListBuilder()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;

    • getStringListOrBuilder

      public StringListSettingOrBuilder getStringListOrBuilder()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;
      Specified by:
      getStringListOrBuilder in interface SettingsDefinitionOrBuilder

    • hasMinMax

      public boolean hasMinMax()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;
      Specified by:
      hasMinMax in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the minMax field is set.

    • getMinMax

      public MinMaxSetting getMinMax()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;
      Specified by:
      getMinMax in interface SettingsDefinitionOrBuilder
      Returns:
      The minMax.

    • setMinMax

      public SettingsDefinition.Builder setMinMax(MinMaxSetting value)
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;

    • setMinMax

      public SettingsDefinition.Builder setMinMax(MinMaxSetting.Builder builderForValue)
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;

    • mergeMinMax

      public SettingsDefinition.Builder mergeMinMax(MinMaxSetting value)
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;

    • clearMinMax

      public SettingsDefinition.Builder clearMinMax()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;

    • getMinMaxBuilder

      public MinMaxSetting.Builder getMinMaxBuilder()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;

    • getMinMaxOrBuilder

      public MinMaxSettingOrBuilder getMinMaxOrBuilder()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;
      Specified by:
      getMinMaxOrBuilder in interface SettingsDefinitionOrBuilder