Class SettingsPage.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<SettingsPage.Builder>
com.google.protobuf.GeneratedMessage.Builder<SettingsPage.Builder>
com.soulfiremc.grpc.generated.SettingsPage.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SettingsPageOrBuilder, Cloneable
Enclosing class:
SettingsPage
public static final class SettingsPage.Builder extends com.google.protobuf.GeneratedMessage.Builder<SettingsPage.Builder> implements SettingsPageOrBuilder
A settings page that groups related settings together for UI navigation.
Pages provide a logical organization of settings with visual elements like
icons and names. Each page references settings by their identifiers rather
than embedding the definitions, allowing settings to be shared across pages.
Protobuf type soulfire.v1.SettingsPage

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public SettingsPage.Builder mergeFrom(SettingsPage other)

    • isInitialized

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

    • mergeFrom

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

    • getId

      public String getId()
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Specified by:
      getId in interface SettingsPageOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Specified by:
      getIdBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for id.

    • setId

      public SettingsPage.Builder setId(String value)
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public SettingsPage.Builder clearId()
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Returns:
      This builder for chaining.

    • setIdBytes

      public SettingsPage.Builder setIdBytes(com.google.protobuf.ByteString value)
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.

    • hasOwningPluginId

      public boolean hasOwningPluginId()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Specified by:
      hasOwningPluginId in interface SettingsPageOrBuilder
      Returns:
      Whether the owningPluginId field is set.

    • getOwningPluginId

      public String getOwningPluginId()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Specified by:
      getOwningPluginId in interface SettingsPageOrBuilder
      Returns:
      The owningPluginId.

    • getOwningPluginIdBytes

      public com.google.protobuf.ByteString getOwningPluginIdBytes()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Specified by:
      getOwningPluginIdBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for owningPluginId.

    • setOwningPluginId

      public SettingsPage.Builder setOwningPluginId(String value)
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Parameters:
      value - The owningPluginId to set.
      Returns:
      This builder for chaining.

    • clearOwningPluginId

      public SettingsPage.Builder clearOwningPluginId()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Returns:
      This builder for chaining.

    • setOwningPluginIdBytes

      public SettingsPage.Builder setOwningPluginIdBytes(com.google.protobuf.ByteString value)
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Parameters:
      value - The bytes for owningPluginId to set.
      Returns:
      This builder for chaining.

    • getPageName

      public String getPageName()
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Specified by:
      getPageName in interface SettingsPageOrBuilder
      Returns:
      The pageName.

    • getPageNameBytes

      public com.google.protobuf.ByteString getPageNameBytes()
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Specified by:
      getPageNameBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for pageName.

    • setPageName

      public SettingsPage.Builder setPageName(String value)
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Parameters:
      value - The pageName to set.
      Returns:
      This builder for chaining.

    • clearPageName

      public SettingsPage.Builder clearPageName()
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Returns:
      This builder for chaining.

    • setPageNameBytes

      public SettingsPage.Builder setPageNameBytes(com.google.protobuf.ByteString value)
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Parameters:
      value - The bytes for pageName to set.
      Returns:
      This builder for chaining.

    • getEntriesList

      public List<SettingsEntryIdentifier> getEntriesList()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesList in interface SettingsPageOrBuilder

    • getEntriesCount

      public int getEntriesCount()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesCount in interface SettingsPageOrBuilder

    • getEntries

      public SettingsEntryIdentifier getEntries(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntries in interface SettingsPageOrBuilder

    • setEntries

      public SettingsPage.Builder setEntries(int index, SettingsEntryIdentifier value)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • setEntries

      public SettingsPage.Builder setEntries(int index, SettingsEntryIdentifier.Builder builderForValue)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • addEntries

      public SettingsPage.Builder addEntries(SettingsEntryIdentifier value)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • addEntries

      public SettingsPage.Builder addEntries(int index, SettingsEntryIdentifier value)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • addEntries

      public SettingsPage.Builder addEntries(SettingsEntryIdentifier.Builder builderForValue)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • addEntries

      public SettingsPage.Builder addEntries(int index, SettingsEntryIdentifier.Builder builderForValue)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • addAllEntries

      public SettingsPage.Builder addAllEntries(Iterable<? extends SettingsEntryIdentifier> values)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • clearEntries

      public SettingsPage.Builder clearEntries()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • removeEntries

      public SettingsPage.Builder removeEntries(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getEntriesBuilder

      public SettingsEntryIdentifier.Builder getEntriesBuilder(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getEntriesOrBuilder

      public SettingsEntryIdentifierOrBuilder getEntriesOrBuilder(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesOrBuilder in interface SettingsPageOrBuilder

    • getEntriesOrBuilderList

      public List<? extends SettingsEntryIdentifierOrBuilder> getEntriesOrBuilderList()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesOrBuilderList in interface SettingsPageOrBuilder

    • addEntriesBuilder

      public SettingsEntryIdentifier.Builder addEntriesBuilder()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • addEntriesBuilder

      public SettingsEntryIdentifier.Builder addEntriesBuilder(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getEntriesBuilderList

      public List<SettingsEntryIdentifier.Builder> getEntriesBuilderList()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getIconId

      public String getIconId()
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Specified by:
      getIconId in interface SettingsPageOrBuilder
      Returns:
      The iconId.

    • getIconIdBytes

      public com.google.protobuf.ByteString getIconIdBytes()
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Specified by:
      getIconIdBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for iconId.

    • setIconId

      public SettingsPage.Builder setIconId(String value)
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Parameters:
      value - The iconId to set.
      Returns:
      This builder for chaining.

    • clearIconId

      public SettingsPage.Builder clearIconId()
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Returns:
      This builder for chaining.

    • setIconIdBytes

      public SettingsPage.Builder setIconIdBytes(com.google.protobuf.ByteString value)
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Parameters:
      value - The bytes for iconId to set.
      Returns:
      This builder for chaining.

    • hasEnabledIdentifier

      public boolean hasEnabledIdentifier()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Specified by:
      hasEnabledIdentifier in interface SettingsPageOrBuilder
      Returns:
      Whether the enabledIdentifier field is set.

    • getEnabledIdentifier

      public SettingsEntryIdentifier getEnabledIdentifier()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Specified by:
      getEnabledIdentifier in interface SettingsPageOrBuilder
      Returns:
      The enabledIdentifier.

    • setEnabledIdentifier

      public SettingsPage.Builder setEnabledIdentifier(SettingsEntryIdentifier value)
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;

    • setEnabledIdentifier

      public SettingsPage.Builder setEnabledIdentifier(SettingsEntryIdentifier.Builder builderForValue)
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;

    • mergeEnabledIdentifier

      public SettingsPage.Builder mergeEnabledIdentifier(SettingsEntryIdentifier value)
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;

    • clearEnabledIdentifier

      public SettingsPage.Builder clearEnabledIdentifier()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;

    • getEnabledIdentifierBuilder

      public SettingsEntryIdentifier.Builder getEnabledIdentifierBuilder()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;

    • getEnabledIdentifierOrBuilder

      public SettingsEntryIdentifierOrBuilder getEnabledIdentifierOrBuilder()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Specified by:
      getEnabledIdentifierOrBuilder in interface SettingsPageOrBuilder