Package dk.gtz.graphedit.viewmodel

Record Class ViewModelProject

java.lang.Object
java.lang.Record
dk.gtz.graphedit.viewmodel.ViewModelProject
Record Components:
metadata - A map of generic string-encoded metadata, useful for syntax=specific data
name - The name of the project
rootDirectory - The directory containing the on-disk file
isSavedInTemp - Whether or not the project is currently a temporary project
excludeFiles - A list of files to exclude from the project, can be glob-specifications
runTargets - A list of ViewModelRunTarget associated with this project
public record ViewModelProject(javafx.beans.property.SimpleListProperty<javafx.util.Pair<javafx.beans.property.StringProperty,javafx.beans.property.StringProperty>> metadata, javafx.beans.property.SimpleStringProperty name, javafx.beans.property.SimpleStringProperty rootDirectory, javafx.beans.property.SimpleBooleanProperty isSavedInTemp, javafx.beans.property.SimpleListProperty<javafx.beans.property.StringProperty> excludeFiles, javafx.beans.property.SimpleListProperty<ViewModelRunTarget> runTargets) extends Record
Viewmodel version of the on-disk file structure for a project file Not to be confused with ViewModelProjectResource, this class represents a graphedit project.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ViewModelProject(ModelProject modelProject)
    Constructs a new temporary viewmodel project based on a model instance
    ViewModelProject(ModelProject modelProject, Optional<String> rootDirectory)
    Constructs a new viewmodel project based on a model instance and an optional rootdirectory
    ViewModelProject(javafx.beans.property.SimpleListProperty<javafx.util.Pair<javafx.beans.property.StringProperty,javafx.beans.property.StringProperty>> metadata, javafx.beans.property.SimpleStringProperty name, javafx.beans.property.SimpleStringProperty rootDirectory, javafx.beans.property.SimpleBooleanProperty isSavedInTemp, javafx.beans.property.SimpleListProperty<javafx.beans.property.StringProperty> excludeFiles, javafx.beans.property.SimpleListProperty<ViewModelRunTarget> runTargets)
    Creates an instance of a ViewModelProject record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    javafx.beans.property.SimpleListProperty<javafx.beans.property.StringProperty>
    excludeFiles()
    Returns the value of the excludeFiles record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    javafx.beans.property.SimpleBooleanProperty
    isSavedInTemp()
    Returns the value of the isSavedInTemp record component.
    javafx.beans.property.SimpleListProperty<javafx.util.Pair<javafx.beans.property.StringProperty,javafx.beans.property.StringProperty>>
    metadata()
    Returns the value of the metadata record component.
    javafx.beans.property.SimpleStringProperty
    name()
    Returns the value of the name record component.
    javafx.beans.property.SimpleStringProperty
    rootDirectory()
    Returns the value of the rootDirectory record component.
    javafx.beans.property.SimpleListProperty<ViewModelRunTarget>
    runTargets()
    Returns the value of the runTargets record component.
    ModelProject
    toModel()
    Converts this viewmodel into a model type
    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

    • ViewModelProject

      public ViewModelProject(ModelProject modelProject) throws IOException
      Constructs a new temporary viewmodel project based on a model instance
      Parameters:
      modelProject - The model project datastructure to base on
      Throws:
      IOException - when temporary directory creation failed

    • ViewModelProject

      public ViewModelProject(ModelProject modelProject, Optional<String> rootDirectory) throws IOException
      Constructs a new viewmodel project based on a model instance and an optional rootdirectory
      Parameters:
      modelProject - The model project datastructure to base on
      rootDirectory - When provided, a valid file path containing the associated model project file, else will create a new temp directory for you
      Throws:
      IOException - when temporary directory creation failed

    • ViewModelProject

      public ViewModelProject(javafx.beans.property.SimpleListProperty<javafx.util.Pair<javafx.beans.property.StringProperty,javafx.beans.property.StringProperty>> metadata, javafx.beans.property.SimpleStringProperty name, javafx.beans.property.SimpleStringProperty rootDirectory, javafx.beans.property.SimpleBooleanProperty isSavedInTemp, javafx.beans.property.SimpleListProperty<javafx.beans.property.StringProperty> excludeFiles, javafx.beans.property.SimpleListProperty<ViewModelRunTarget> runTargets)
      Creates an instance of a ViewModelProject record class.
      Parameters:
      metadata - the value for the metadata record component
      name - the value for the name record component
      rootDirectory - the value for the rootDirectory record component
      isSavedInTemp - the value for the isSavedInTemp record component
      excludeFiles - the value for the excludeFiles record component
      runTargets - the value for the runTargets record component

  • Method Details

    • toModel

      public ModelProject toModel()
      Converts this viewmodel into a model type
      Returns:
      A model version of this project data

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

    • metadata

      public javafx.beans.property.SimpleListProperty<javafx.util.Pair<javafx.beans.property.StringProperty,javafx.beans.property.StringProperty>> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component

    • name

      public javafx.beans.property.SimpleStringProperty name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • rootDirectory

      public javafx.beans.property.SimpleStringProperty rootDirectory()
      Returns the value of the rootDirectory record component.
      Returns:
      the value of the rootDirectory record component

    • isSavedInTemp

      public javafx.beans.property.SimpleBooleanProperty isSavedInTemp()
      Returns the value of the isSavedInTemp record component.
      Returns:
      the value of the isSavedInTemp record component

    • excludeFiles

      public javafx.beans.property.SimpleListProperty<javafx.beans.property.StringProperty> excludeFiles()
      Returns the value of the excludeFiles record component.
      Returns:
      the value of the excludeFiles record component

    • runTargets

      public javafx.beans.property.SimpleListProperty<ViewModelRunTarget> runTargets()
      Returns the value of the runTargets record component.
      Returns:
      the value of the runTargets record component