Package gg.xp.xivsupport.timelines.cbevents

Record Class CbfMap<X>

java.lang.Object
java.lang.Record
gg.xp.xivsupport.timelines.cbevents.CbfMap<X>
Type Parameters:
X - The Triggevent event type
Record Components:
cbField - The cactbot field name
ourLabel - Groovy script for the event on our end
conversion - How to convert the value to a predicate
public record CbfMap<X>(String cbField, String ourLabel, gg.xp.xivsupport.timelines.cbevents.CbConversion<X> conversion) extends Record
Cactbot field mapping

  • Constructor Summary

    Constructors
    Constructor
    Description
    CbfMap(String cbField, String ourLabel, gg.xp.xivsupport.timelines.cbevents.CbConversion<X> conversion)
    Creates an instance of a CbfMap record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    cbField()
    Returns the value of the cbField record component.
    gg.xp.xivsupport.timelines.cbevents.CbConversion<X>
    conversion()
    Returns the value of the conversion record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    ourLabel()
    Returns the value of the ourLabel record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CbfMap

      public CbfMap(String cbField, @Language("Groovy") String ourLabel, gg.xp.xivsupport.timelines.cbevents.CbConversion<X> conversion)
      Creates an instance of a CbfMap record class.
      Parameters:
      cbField - the value for the cbField record component
      ourLabel - the value for the ourLabel record component
      conversion - the value for the conversion record component

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

    • cbField

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

    • ourLabel

      @Language("Groovy") public String ourLabel()
      Returns the value of the ourLabel record component.
      Returns:
      the value of the ourLabel record component

    • conversion

      public gg.xp.xivsupport.timelines.cbevents.CbConversion<X> conversion()
      Returns the value of the conversion record component.
      Returns:
      the value of the conversion record component