Record Class ImportManifest.ResourceItem

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.importexport.ImportManifest.ResourceItem
Record Components:
name - escaped resource path token below its type (folder segments joined by /, special characters percent-escaped); null for singletons.
displayName - human-friendly display name, falls back to the resource's own name when no resource type meta is available.
collection - the collection the resource lived in inside the archive.
collectionAvailable - true if collection exists on the receiving gateway. When false, applying this resource as-is is rejected; it must be remapped to a collection that exists, because an import never creates one.
conflict - non-null when the resource would require user resolution before apply.
Enclosing class:
ImportManifest

public static record ImportManifest.ResourceItem(@Nullable String name, String displayName, String collection, boolean collectionAvailable, @Nullable ImportManifest.ResourceConflict conflict) extends Record
A single config resource entry from the archive.
  • Constructor Details

    • ResourceItem

      public ResourceItem(@Nullable String name, String displayName, String collection, boolean collectionAvailable, @Nullable ImportManifest.ResourceConflict conflict)
      Creates an instance of a ResourceItem record class.
      Parameters:
      name - the value for the name record component
      displayName - the value for the displayName record component
      collection - the value for the collection record component
      collectionAvailable - the value for the collectionAvailable record component
      conflict - the value for the conflict 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.
    • name

      public @Nullable String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component
    • displayName

      public String displayName()
      Returns the value of the displayName record component.
      Returns:
      the value of the displayName record component
    • collection

      public String collection()
      Returns the value of the collection record component.
      Returns:
      the value of the collection record component
    • collectionAvailable

      public boolean collectionAvailable()
      Returns the value of the collectionAvailable record component.
      Returns:
      the value of the collectionAvailable record component
    • conflict

      public @Nullable ImportManifest.ResourceConflict conflict()
      Returns the value of the conflict record component.
      Returns:
      the value of the conflict record component