Package com.github.siroshun09.configapi.core.node

Record Class StringValue

java.lang.Object
java.lang.Record
com.github.siroshun09.configapi.core.node.StringValue
Record Components:
value - a String value
All Implemented Interfaces:
Node<String>, StringRepresentable, ValueNode<String>
public record StringValue(@NotNull String value) extends Record implements ValueNode<String>, StringRepresentable
A Node implementation that holds a String value.

  • Field Details

  • Constructor Details

    • StringValue

      public StringValue(@NotNull @NotNull String value)
      A constructor of StringValue.
      Parameters:
      value - a String value

  • Method Details

    • fromString

      @NotNull public static @NotNull StringValue fromString(@NotNull @NotNull String value)
      Creates a StringValue from the given string or returns EMPTY if the given string is empty.
      Parameters:
      value - a String value
      Returns:
      a StringValue

    • hasValue

      public boolean hasValue()
      Description copied from interface: Node
      Checks if this Node holds an object.

      The default implementation of this method checks if the returning value from Node.value() is not null.

      Specified by:
      hasValue in interface Node<String>
      Returns:
      true if this Node holds an object, otherwise false

    • accept

      @NotNull public @NotNull VisitResult accept(@NotNull @NotNull NodeVisitor visitor)
      Description copied from interface: Node
      Accepts a NodeVisitor for this Node.
      Specified by:
      accept in interface Node<String>
      Parameters:
      visitor - a NodeVisitor to accept
      Returns:
      a VisitResult

    • asString

      @NotNull public @NotNull String asString()
      Gets the value as String.
      Specified by:
      asString in interface StringRepresentable
      Returns:
      the value as String

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • value

      @NotNull public @NotNull String value()
      Returns the value of the value record component.
      Specified by:
      value in interface Node<String>
      Specified by:
      value in interface ValueNode<String>
      Returns:
      the value of the value record component