Package dev.turboism.sdk.hostread

Record Class ProjectWorkspaceSnapshot

java.lang.Object
java.lang.Record
dev.turboism.sdk.hostread.ProjectWorkspaceSnapshot
Record Components:
project - the open project's snapshot, empty when the host reported no project
workspace - the workspace snapshot, empty when the host reported no workspace
All Implemented Interfaces:
AsyncHostReadValue
public record ProjectWorkspaceSnapshot(Optional<ProjectSnapshot> project, Optional<WorkspaceSnapshot> workspace) extends Record implements AsyncHostReadValue
The value delivered by a AsyncHostReadIntent.PROJECT_WORKSPACE_SNAPSHOT read: a point-in-time view of the host's open project and workspace.

Both components are optional and independently so — the host may have a workspace open with no project, or expose neither. An empty component means the host did not report that state at the moment of the read, not that the read failed; failures are reported through AsyncHostReadResult instead.

  • Constructor Details

    • ProjectWorkspaceSnapshot

      public ProjectWorkspaceSnapshot(Optional<ProjectSnapshot> project, Optional<WorkspaceSnapshot> workspace)
      Creates an instance of a ProjectWorkspaceSnapshot record class.
      Parameters:
      project - the value for the project record component
      workspace - the value for the workspace 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.

    • project

      public Optional<ProjectSnapshot> project()
      Returns the value of the project record component.
      Returns:
      the value of the project record component

    • workspace

      public Optional<WorkspaceSnapshot> workspace()
      Returns the value of the workspace record component.
      Returns:
      the value of the workspace record component