Class StringSetting

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.StringSetting
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StringSettingOrBuilder, Serializable
@Generated public final class StringSetting extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StringSetting.Builder
    UI definition for a string/text setting.
    static enum 
    StringSetting.InputType
    The type of text input to render in the UI.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEF_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    DISABLED_FIELD_NUMBER
     
    static final int
    INPUT_TYPE_FIELD_NUMBER
     
    static final int
    MAX_LENGTH_FIELD_NUMBER
     
    static final int
    MIN_LENGTH_FIELD_NUMBER
     
    static final int
    PATTERN_FIELD_NUMBER
     
    static final int
    PLACEHOLDER_FIELD_NUMBER
     
    static final int
    UI_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getDef()
    The default value used when no value is configured.
    static StringSetting
    getDefaultInstance()
     
    StringSetting
    getDefaultInstanceForType()
     
    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.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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).
    com.google.protobuf.Parser<StringSetting>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static StringSetting.Builder
    newBuilder()
     
    static StringSetting.Builder
    newBuilder(StringSetting prototype)
     
    StringSetting.Builder
    newBuilderForType()
     
    protected StringSetting.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static StringSetting
    parseDelimitedFrom(InputStream input)
     
    static StringSetting
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StringSetting
    parseFrom(byte[] data)
     
    static StringSetting
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StringSetting
    parseFrom(com.google.protobuf.ByteString data)
     
    static StringSetting
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StringSetting
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StringSetting
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StringSetting
    parseFrom(InputStream input)
     
    static StringSetting
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StringSetting
    parseFrom(ByteBuffer data)
     
    static StringSetting
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StringSetting>
    parser()
     
    StringSetting.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • 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

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

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

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

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

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

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

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

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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StringSetting parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StringSetting parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StringSetting parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StringSetting parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StringSetting parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StringSetting parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StringSetting parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StringSetting parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StringSetting parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StringSetting parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StringSetting parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StringSetting parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static StringSetting.Builder newBuilder()

    • newBuilder

      public static StringSetting.Builder newBuilder(StringSetting prototype)

    • toBuilder

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

    • newBuilderForType

      protected StringSetting.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StringSetting getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StringSetting> parser()

    • getParserForType

      public com.google.protobuf.Parser<StringSetting> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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