Record Class PunishmentDetailsCalculator.CalculationResult

java.lang.Object
java.lang.Record
space.arim.libertybans.api.punish.PunishmentDetailsCalculator.CalculationResult
Record Components:
type - the type
reason - the reason
duration - the duration of the punishment starting now, Duration.ZERO for permanent
scope - the scope
Enclosing interface:
PunishmentDetailsCalculator
public static record PunishmentDetailsCalculator.CalculationResult(PunishmentType type, String reason, Duration duration, ServerScope scope) extends Record
The computed details of a punishment

  • Constructor Details

    • CalculationResult

      public CalculationResult(PunishmentType type, String reason, Duration duration, ServerScope scope)
      Creates
      Parameters:
      type - the type
      reason - the reason
      duration - the duration of the punishment starting now, Duration.ZERO for permanent
      scope - the scope
      Throws:
      IllegalArgumentException - if duration is negative, or if the punishment type is PunishmentType.KICK but the duration is not permanent

  • Method Details

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

    • type

      public PunishmentType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • reason

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

    • duration

      public Duration duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component

    • scope

      public ServerScope scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component