Package ai.timefold.solver.core.impl.domain.variable.listener.support.violation

Record Class VariableSnapshot<Solution_>

java.lang.Object
java.lang.Record
ai.timefold.solver.core.impl.domain.variable.listener.support.violation.VariableSnapshot<Solution_>
Type Parameters:
Solution_ -
Record Components:
variableId - The entity/variable pair that is recorded.
value - The recorded value of the variable for the given entity.
public record VariableSnapshot<Solution_>(VariableId<Solution_> variableId, Object value) extends Record
A VariableSnapshot is a snapshot of the value of a variable for a given entity. Only VariableSnapshot from the same solution instance can be compared.

  • Constructor Details

    • VariableSnapshot

      public VariableSnapshot(VariableDescriptor<Solution_> variableDescriptor, Object entity)

    • VariableSnapshot

      public VariableSnapshot(VariableId<Solution_> variableId, Object value)
      Creates an instance of a VariableSnapshot record class.
      Parameters:
      variableId - the value for the variableId record component
      value - the value for the value record component

  • Method Details

    • getVariableDescriptor

      public VariableDescriptor<Solution_> getVariableDescriptor()

    • getEntity

      public Object getEntity()

    • getValue

      public Object getValue()

    • getVariableId

      public VariableId<Solution_> getVariableId()

    • restore

      public void restore()

    • isDifferentFrom

      public boolean isDifferentFrom(VariableSnapshot<Solution_> other)

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

    • variableId

      public VariableId<Solution_> variableId()
      Returns the value of the variableId record component.
      Returns:
      the value of the variableId record component

    • value

      public Object value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component