Package com.inductiveautomation.ignition.common.project

Record Class ProjectImport

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.project.ProjectImport
public record ProjectImport(@Nonnull NamedManifest namedManifest, @Nonnull Set<Resource> resources) extends Record
A ProjectImport is a self-contained collection of the information that represents a single Ignition Project. This includes a NamedManifest and a set of Resource objects. Note that this is strictly a single project. If this project inherits from another, that other project is not included in this object, just a link to the parent by name is part of the manifest.

This collection can be serialized into a *.zip file using ProjectFileUtil.exportToZip(ResourceCollectionManifest, List, OutputStream). It can be created from a zip byte stream (e.g. file) using ProjectFileUtil.importFromZip(InputStream, String)

  • Constructor Details

    • ProjectImport

      public ProjectImport(@Nonnull NamedManifest namedManifest, @Nonnull Set<Resource> resources)
      Creates an instance of a ProjectImport record class.
      Parameters:
      namedManifest - the value for the namedManifest record component
      resources - the value for the resources record component

  • Method Details

    • getName

      public String getName()

    • getManifest

      public ResourceCollectionManifest getManifest()

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

    • namedManifest

      @Nonnull public NamedManifest namedManifest()
      Returns the value of the namedManifest record component.
      Returns:
      the value of the namedManifest record component

    • resources

      @Nonnull public Set<Resource> resources()
      Returns the value of the resources record component.
      Returns:
      the value of the resources record component