Package dev.satyrn.papermc.api.configuration.v1

Class ConfigurationContainer

java.lang.Object
dev.satyrn.papermc.api.configuration.v1.ConfigurationNode<Void>
dev.satyrn.papermc.api.configuration.v1.ConfigurationContainer
Direct Known Subclasses:
MySQLConfiguration
@Deprecated(since="1.9.0") public abstract class ConfigurationContainer extends ConfigurationNode<Void>
Deprecated.
Since 1.9.0. Use ContainerNode and RootNode instead. Will be removed in a future version.
Represents a base type for a class which contains several other configuration containers and/or nodes.
Since:
1.0.0
Author:
Isabel Maskrey

  • Constructor Details

    • ConfigurationContainer

      protected ConfigurationContainer(@NotNull @NotNull ConfigurationNode<?> parent, @Nullable @Nullable String name)
      Deprecated.
      Initializes the configuration container as a child of another container.
      Parameters:
      parent - The node parent.
      name - The name of the container.
      Since:
      1.0.0

    • ConfigurationContainer

      @Deprecated(since="1.6.0", forRemoval=true) protected ConfigurationContainer(@NotNull @NotNull org.bukkit.configuration.Configuration config)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 1.6.0. Use constructors which specify parent plugin instead. Will be removed in a future version.
      Initializes the configuration container as a root container.
      Parameters:
      config - The configuration instance.
      Since:
      1.0.0

    • ConfigurationContainer

      protected ConfigurationContainer(@NotNull @NotNull org.bukkit.plugin.Plugin plugin)
      Deprecated.
      Initializes the configuration container as a root container.
      Parameters:
      plugin - The plugin instance.
      Since:
      1.0.0

    • ConfigurationContainer

      @Deprecated(since="1.9.0", forRemoval=true) protected ConfigurationContainer(@NotNull @NotNull org.bukkit.plugin.Plugin plugin, @NotNull @NotNull org.bukkit.configuration.Configuration config)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1.9.0. To be removed in a future version.
      Initializes the configuration container as a root container.
      Parameters:
      plugin - The plugin instance.
      config - The configuration instance.
      Since:
      1.6.0

  • Method Details

    • value

      @Nullable public final @Nullable Void value()
      Deprecated.
      Gets the current value of the node.

      Always returns null for configuration containers.

      Specified by:
      value in class ConfigurationNode<Void>
      Returns:
      null
      Since:
      1.0-SNAPSHOT

    • defaultValue

      @Nullable public final @Nullable Void defaultValue()
      Deprecated.
      Gets the default value of the node.

      Always returns null for configuration containers.

      Specified by:
      defaultValue in class ConfigurationNode<Void>
      Returns:
      The default value.
      Since:
      1.3.0

    • setConfigValue

      public void setConfigValue(@Nullable @Nullable Void value)
      Deprecated.
      Sets the value of the node.

      Does nothing for configuration containers.

      Overrides:
      setConfigValue in class ConfigurationNode<Void>
      Parameters:
      value - The value to set.
      Since:
      1.10.0

    • toString

      public void toString(@NotNull @NotNull StringBuilder stringBuilder)
      Deprecated.
      Builds the string representation of the node.

      By default, ContainerNodes return just the name of the node.

      Overrides:
      toString in class ConfigurationNode<Void>
      Parameters:
      stringBuilder - The StringBuilder with which to build the string.
      Since:
      1.10.0