Package com.marswars.dashboard

Record Class DashboardBridge.Config

java.lang.Object
java.lang.Record
com.marswars.dashboard.DashboardBridge.Config
Record Components:
toRobotTable - NT table path the dashboard writes to and this bridge reads from (e.g. "/ReefControls/ToRobot")
toDashboardTable - NT table path this bridge writes to and the dashboard reads from
webServerPort - port to serve the static dashboard web app on
webServerDeploySubdir - subdirectory of the robot project's deploy directory containing the dashboard's HTML/CSS/JS
Enclosing class:
DashboardBridge
public static record DashboardBridge.Config(String toRobotTable, String toDashboardTable, int webServerPort, String webServerDeploySubdir) extends Record

  • Constructor Details

    • Config

      public Config(String toRobotTable, String toDashboardTable, int webServerPort, String webServerDeploySubdir)
      Creates an instance of a Config record class.
      Parameters:
      toRobotTable - the value for the toRobotTable record component
      toDashboardTable - the value for the toDashboardTable record component
      webServerPort - the value for the webServerPort record component
      webServerDeploySubdir - the value for the webServerDeploySubdir 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 '=='.
      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.

    • toRobotTable

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

    • toDashboardTable

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

    • webServerPort

      public int webServerPort()
      Returns the value of the webServerPort record component.
      Returns:
      the value of the webServerPort record component

    • webServerDeploySubdir

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