Package org.teleight.teleightbots.api.objects

Record Class BackgroundTypePattern

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.objects.BackgroundTypePattern
All Implemented Interfaces:
Serializable, ApiResult, BackgroundType
public record BackgroundTypePattern(@NotNull Document document, @NotNull BackgroundFill fill, @org.checkerframework.common.value.qual.IntRange(from=0L, to=100L) int intensity, boolean isInverted, boolean isMoving) extends Record implements BackgroundType
See Also:

  • Field Summary

    Fields inherited from interface org.teleight.teleightbots.api.objects.BackgroundType

    TYPE_NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    BackgroundTypePattern(@NotNull Document document, @NotNull BackgroundFill fill, @org.checkerframework.common.value.qual.IntRange(from=0L, to=100L) int intensity, boolean isInverted, boolean isMoving)
    Creates an instance of a BackgroundTypePattern record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Document
    document()
    Returns the value of the document record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull BackgroundFill
    fill()
    Returns the value of the fill record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    @org.checkerframework.common.value.qual.IntRange(from=0L, to=100L) int
    intensity()
    Returns the value of the intensity record component.
    boolean
    isInverted()
    Returns the value of the isInverted record component.
    boolean
    isMoving()
    Returns the value of the isMoving record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BackgroundTypePattern

      public BackgroundTypePattern(@NotNull @NotNull Document document, @NotNull @NotNull BackgroundFill fill, @org.checkerframework.common.value.qual.IntRange(from=0L, to=100L) int intensity, boolean isInverted, boolean isMoving)
      Creates an instance of a BackgroundTypePattern record class.
      Parameters:
      document - the value for the document record component
      fill - the value for the fill record component
      intensity - the value for the intensity record component
      isInverted - the value for the isInverted record component
      isMoving - the value for the isMoving record component

  • Method Details

    • type

      public String type()
      Specified by:
      type in interface BackgroundType

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • document

      @NotNull public @NotNull Document document()
      Returns the value of the document record component.
      Returns:
      the value of the document record component

    • fill

      @NotNull public @NotNull BackgroundFill fill()
      Returns the value of the fill record component.
      Returns:
      the value of the fill record component

    • intensity

      public @org.checkerframework.common.value.qual.IntRange(from=0L, to=100L) int intensity()
      Returns the value of the intensity record component.
      Returns:
      the value of the intensity record component

    • isInverted

      public boolean isInverted()
      Returns the value of the isInverted record component.
      Returns:
      the value of the isInverted record component

    • isMoving

      public boolean isMoving()
      Returns the value of the isMoving record component.
      Returns:
      the value of the isMoving record component