Package com.inductiveautomation.ignition.designer.location

Record Class Location

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.designer.location.Location
public record Location(ProjectResourceId projectResourceId, Map<String,String> valueMap) extends Record
A Location uniquely identifies a resource in the project (by ProjectResourceId), plus some additional context in the form of simple string key/value pairs. Individual module/resource workspaces can indicate they support being 'located' by implementing the Locatable interface.

  • Constructor Details

    • Location

      public Location(com.inductiveautomation.ignition.common.tags.config.model.TagReferenceLocation tagReferenceLocation)

    • Location

      public Location(ProjectResourceId projectResourceId, Map<String,String> valueMap)
      Creates an instance of a Location record class.
      Parameters:
      projectResourceId - the value for the projectResourceId record component
      valueMap - the value for the valueMap record component

  • Method Details

    • getResourcePath

      public ResourcePath getResourcePath()

    • getResourceType

      public ResourceType getResourceType()

    • containsKey

      public boolean containsKey(String key)

    • get

      public String get(String key)

    • toString

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

    • projectResourceId

      public ProjectResourceId projectResourceId()
      Returns the value of the projectResourceId record component.
      Returns:
      the value of the projectResourceId record component

    • valueMap

      public Map<String,String> valueMap()
      Returns the value of the valueMap record component.
      Returns:
      the value of the valueMap record component