Class StringSetting.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<StringSetting.Builder>
com.google.protobuf.GeneratedMessage.Builder<StringSetting.Builder>
com.soulfiremc.grpc.generated.StringSetting.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StringSettingOrBuilder, Cloneable
Enclosing class:
StringSetting
public static final class StringSetting.Builder extends com.google.protobuf.GeneratedMessage.Builder<StringSetting.Builder> implements StringSettingOrBuilder
UI definition for a string/text setting.
Used to render text input fields in the client UI with appropriate validation
and visual styling based on the input type.
Protobuf type soulfire.v1.StringSetting

  • 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<StringSetting.Builder>

    • clear

      public StringSetting.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<StringSetting.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<StringSetting.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public StringSetting.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<StringSetting.Builder>

    • mergeFrom

      public StringSetting.Builder mergeFrom(StringSetting other)

    • isInitialized

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

    • mergeFrom

      public StringSetting.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<StringSetting.Builder>
      Throws:
      IOException

    • getUiName

      public String getUiName()
      The display name shown in the UI label for this setting.
      string ui_name = 1;
      Specified by:
      getUiName in interface StringSettingOrBuilder
      Returns:
      The uiName.

    • getUiNameBytes

      public com.google.protobuf.ByteString getUiNameBytes()
      The display name shown in the UI label for this setting.
      string ui_name = 1;
      Specified by:
      getUiNameBytes in interface StringSettingOrBuilder
      Returns:
      The bytes for uiName.

    • setUiName

      public StringSetting.Builder setUiName(String value)
      The display name shown in the UI label for this setting.
      string ui_name = 1;
      Parameters:
      value - The uiName to set.
      Returns:
      This builder for chaining.

    • clearUiName

      public StringSetting.Builder clearUiName()
      The display name shown in the UI label for this setting.
      string ui_name = 1;
      Returns:
      This builder for chaining.

    • setUiNameBytes

      public StringSetting.Builder setUiNameBytes(com.google.protobuf.ByteString value)
      The display name shown in the UI label for this setting.
      string ui_name = 1;
      Parameters:
      value - The bytes for uiName to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
      A longer description explaining what this setting does.
Typically shown as a tooltip or help text.
      string description = 2;
      Specified by:
      getDescription in interface StringSettingOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      A longer description explaining what this setting does.
Typically shown as a tooltip or help text.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface StringSettingOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public StringSetting.Builder setDescription(String value)
      A longer description explaining what this setting does.
Typically shown as a tooltip or help text.
      string description = 2;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public StringSetting.Builder clearDescription()
      A longer description explaining what this setting does.
Typically shown as a tooltip or help text.
      string description = 2;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public StringSetting.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
      A longer description explaining what this setting does.
Typically shown as a tooltip or help text.
      string description = 2;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • getDef

      public String getDef()
      The default value used when no value is configured.
      string def = 3;
      Specified by:
      getDef in interface StringSettingOrBuilder
      Returns:
      The def.

    • getDefBytes

      public com.google.protobuf.ByteString getDefBytes()
      The default value used when no value is configured.
      string def = 3;
      Specified by:
      getDefBytes in interface StringSettingOrBuilder
      Returns:
      The bytes for def.

    • setDef

      public StringSetting.Builder setDef(String value)
      The default value used when no value is configured.
      string def = 3;
      Parameters:
      value - The def to set.
      Returns:
      This builder for chaining.

    • clearDef

      public StringSetting.Builder clearDef()
      The default value used when no value is configured.
      string def = 3;
      Returns:
      This builder for chaining.

    • setDefBytes

      public StringSetting.Builder setDefBytes(com.google.protobuf.ByteString value)
      The default value used when no value is configured.
      string def = 3;
      Parameters:
      value - The bytes for def to set.
      Returns:
      This builder for chaining.

    • getInputTypeValue

      public int getInputTypeValue()
      The type of input field to render (affects keyboard, validation, and display).
      .soulfire.v1.StringSetting.InputType input_type = 10;
      Specified by:
      getInputTypeValue in interface StringSettingOrBuilder
      Returns:
      The enum numeric value on the wire for inputType.

    • setInputTypeValue

      public StringSetting.Builder setInputTypeValue(int value)
      The type of input field to render (affects keyboard, validation, and display).
      .soulfire.v1.StringSetting.InputType input_type = 10;
      Parameters:
      value - The enum numeric value on the wire for inputType to set.
      Returns:
      This builder for chaining.

    • getInputType

      public StringSetting.InputType getInputType()
      The type of input field to render (affects keyboard, validation, and display).
      .soulfire.v1.StringSetting.InputType input_type = 10;
      Specified by:
      getInputType in interface StringSettingOrBuilder
      Returns:
      The inputType.

    • setInputType

      public StringSetting.Builder setInputType(StringSetting.InputType value)
      The type of input field to render (affects keyboard, validation, and display).
      .soulfire.v1.StringSetting.InputType input_type = 10;
      Parameters:
      value - The inputType to set.
      Returns:
      This builder for chaining.

    • clearInputType

      public StringSetting.Builder clearInputType()
      The type of input field to render (affects keyboard, validation, and display).
      .soulfire.v1.StringSetting.InputType input_type = 10;
      Returns:
      This builder for chaining.

    • getPlaceholder

      public String getPlaceholder()
      Placeholder text shown when the input is empty.
Provides a hint about expected format or content.
      string placeholder = 6;
      Specified by:
      getPlaceholder in interface StringSettingOrBuilder
      Returns:
      The placeholder.

    • getPlaceholderBytes

      public com.google.protobuf.ByteString getPlaceholderBytes()
      Placeholder text shown when the input is empty.
Provides a hint about expected format or content.
      string placeholder = 6;
      Specified by:
      getPlaceholderBytes in interface StringSettingOrBuilder
      Returns:
      The bytes for placeholder.

    • setPlaceholder

      public StringSetting.Builder setPlaceholder(String value)
      Placeholder text shown when the input is empty.
Provides a hint about expected format or content.
      string placeholder = 6;
      Parameters:
      value - The placeholder to set.
      Returns:
      This builder for chaining.

    • clearPlaceholder

      public StringSetting.Builder clearPlaceholder()
      Placeholder text shown when the input is empty.
Provides a hint about expected format or content.
      string placeholder = 6;
      Returns:
      This builder for chaining.

    • setPlaceholderBytes

      public StringSetting.Builder setPlaceholderBytes(com.google.protobuf.ByteString value)
      Placeholder text shown when the input is empty.
Provides a hint about expected format or content.
      string placeholder = 6;
      Parameters:
      value - The bytes for placeholder to set.
      Returns:
      This builder for chaining.

    • getMinLength

      public int getMinLength()
      Minimum required string length (0 means no minimum).
      int32 min_length = 7;
      Specified by:
      getMinLength in interface StringSettingOrBuilder
      Returns:
      The minLength.

    • setMinLength

      public StringSetting.Builder setMinLength(int value)
      Minimum required string length (0 means no minimum).
      int32 min_length = 7;
      Parameters:
      value - The minLength to set.
      Returns:
      This builder for chaining.

    • clearMinLength

      public StringSetting.Builder clearMinLength()
      Minimum required string length (0 means no minimum).
      int32 min_length = 7;
      Returns:
      This builder for chaining.

    • getMaxLength

      public int getMaxLength()
      Maximum allowed string length (0 means no maximum).
      int32 max_length = 8;
      Specified by:
      getMaxLength in interface StringSettingOrBuilder
      Returns:
      The maxLength.

    • setMaxLength

      public StringSetting.Builder setMaxLength(int value)
      Maximum allowed string length (0 means no maximum).
      int32 max_length = 8;
      Parameters:
      value - The maxLength to set.
      Returns:
      This builder for chaining.

    • clearMaxLength

      public StringSetting.Builder clearMaxLength()
      Maximum allowed string length (0 means no maximum).
      int32 max_length = 8;
      Returns:
      This builder for chaining.

    • getPattern

      public String getPattern()
      Regular expression pattern for value validation.
Empty string means no pattern validation.
      string pattern = 9;
      Specified by:
      getPattern in interface StringSettingOrBuilder
      Returns:
      The pattern.

    • getPatternBytes

      public com.google.protobuf.ByteString getPatternBytes()
      Regular expression pattern for value validation.
Empty string means no pattern validation.
      string pattern = 9;
      Specified by:
      getPatternBytes in interface StringSettingOrBuilder
      Returns:
      The bytes for pattern.

    • setPattern

      public StringSetting.Builder setPattern(String value)
      Regular expression pattern for value validation.
Empty string means no pattern validation.
      string pattern = 9;
      Parameters:
      value - The pattern to set.
      Returns:
      This builder for chaining.

    • clearPattern

      public StringSetting.Builder clearPattern()
      Regular expression pattern for value validation.
Empty string means no pattern validation.
      string pattern = 9;
      Returns:
      This builder for chaining.

    • setPatternBytes

      public StringSetting.Builder setPatternBytes(com.google.protobuf.ByteString value)
      Regular expression pattern for value validation.
Empty string means no pattern validation.
      string pattern = 9;
      Parameters:
      value - The bytes for pattern to set.
      Returns:
      This builder for chaining.

    • getDisabled

      public boolean getDisabled()
      Whether this setting is disabled (read-only) in the UI.
Disabled settings display their value but cannot be modified.
      bool disabled = 11;
      Specified by:
      getDisabled in interface StringSettingOrBuilder
      Returns:
      The disabled.

    • setDisabled

      public StringSetting.Builder setDisabled(boolean value)
      Whether this setting is disabled (read-only) in the UI.
Disabled settings display their value but cannot be modified.
      bool disabled = 11;
      Parameters:
      value - The disabled to set.
      Returns:
      This builder for chaining.

    • clearDisabled

      public StringSetting.Builder clearDisabled()
      Whether this setting is disabled (read-only) in the UI.
Disabled settings display their value but cannot be modified.
      bool disabled = 11;
      Returns:
      This builder for chaining.