Record Class EditorCommand

java.lang.Object
java.lang.Record
it.univr.di.cstnu.gui.EditorCommand
Record Components:
id - stable, kebab-case identifier (e.g. "stn-consistency")
label - human-readable label (e.g. "Consistency")
requiresNodeParameter - true when this command needs a LabeledNode argument (today: only the STN predecessor-subgraph command)

public record EditorCommand(@Nonnull String id, @Nonnull String label, boolean requiresNodeParameter) extends Record
Declarative description of a check/transformation command offered by EditorController for a given network kind. This lets a future view build its buttons/menus without knowing anything about the underlying checking algorithms: it only needs label() for the button text and requiresNodeParameter() to know whether it must ask the user to choose a node before calling EditorController.execute(EditorCommand, LabeledNode).
Author:
posenato
  • Constructor Details

    • EditorCommand

      public EditorCommand(@Nonnull String id, @Nonnull String label, boolean requiresNodeParameter)
      Creates an instance of a EditorCommand record class.
      Parameters:
      id - the value for the id record component
      label - the value for the label record component
      requiresNodeParameter - the value for the requiresNodeParameter 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • id

      @Nonnull public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component
    • label

      @Nonnull public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component
    • requiresNodeParameter

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