Record Class MagicPlaceholders.PlaceholderResult

java.lang.Object
java.lang.Record
dev.ua.theroer.magicutils.placeholders.MagicPlaceholders.PlaceholderResult
Record Components:
value - resolved value (may be null)
error - resolution error (null on success)
Enclosing class:
MagicPlaceholders
public static record MagicPlaceholders.PlaceholderResult(@Nullable String value, @Nullable Throwable error) extends Record
Result of placeholder resolution.

  • Constructor Details

    • PlaceholderResult

      public PlaceholderResult(@Nullable @Nullable String value, @Nullable @Nullable Throwable error)
      Creates an instance of a PlaceholderResult record class.
      Parameters:
      value - the value for the value record component
      error - the value for the error record component

  • Method Details

    • success

      public boolean success()
      Returns true when resolution succeeded.
      Returns:
      true when no error was recorded

    • valueOrEmpty

      public String valueOrEmpty()
      Returns a non-null value or an empty string.
      Returns:
      resolved value or empty 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

      @Nullable public @Nullable String value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • error

      @Nullable public @Nullable Throwable error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component