Interface StringSettingOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StringSetting, StringSetting.Builder
@Generated public interface StringSettingOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDef()
    The default value used when no value is configured.
    com.google.protobuf.ByteString
    getDefBytes()
    The default value used when no value is configured.
    String
    getDescription()
    A longer description explaining what this setting does.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A longer description explaining what this setting does.
    boolean
    getDisabled()
    Whether this setting is disabled (read-only) in the UI.
    StringSetting.InputType
    getInputType()
    The type of input field to render (affects keyboard, validation, and display).
    int
    getInputTypeValue()
    The type of input field to render (affects keyboard, validation, and display).
    int
    getMaxLength()
    Maximum allowed string length (0 means no maximum).
    int
    getMinLength()
    Minimum required string length (0 means no minimum).
    String
    getPattern()
    Regular expression pattern for value validation.
    com.google.protobuf.ByteString
    getPatternBytes()
    Regular expression pattern for value validation.
    String
    getPlaceholder()
    Placeholder text shown when the input is empty.
    com.google.protobuf.ByteString
    getPlaceholderBytes()
    Placeholder text shown when the input is empty.
    String
    getUiName()
    The display name shown in the UI label for this setting.
    com.google.protobuf.ByteString
    getUiNameBytes()
    The display name shown in the UI label for this setting.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getUiName

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

    • getUiNameBytes

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

    • getDescription

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

    • getDescriptionBytes

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

    • getDef

      String getDef()
      The default value used when no value is configured.
      string def = 3;
      Returns:
      The def.

    • getDefBytes

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

    • getInputTypeValue

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

    • getInputType

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

    • getPlaceholder

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

    • getPlaceholderBytes

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

    • getMinLength

      int getMinLength()
      Minimum required string length (0 means no minimum).
      int32 min_length = 7;
      Returns:
      The minLength.

    • getMaxLength

      int getMaxLength()
      Maximum allowed string length (0 means no maximum).
      int32 max_length = 8;
      Returns:
      The maxLength.

    • getPattern

      String getPattern()
      Regular expression pattern for value validation.
Empty string means no pattern validation.
      string pattern = 9;
      Returns:
      The pattern.

    • getPatternBytes

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

    • getDisabled

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