Record Class DesignerResourceMeta

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.designer.model.DesignerResourceMeta
Record Components:
type - the resource type.
title - short human-readable name for use in UI labels and lists.
description - multi-sentence description of what this resource type is and how it is used, intended to be consumed by AI agents and tooling to understand the resource's role within a project.
workspaceKey - key of the ResourceWorkspace that edits this type, or null if the type has no dedicated workspace (e.g. singleton resources edited inline).
singleton - true if at most one resource of this type may exist per project.

public record DesignerResourceMeta(@NonNull ResourceType type, @NonNull String title, @NonNull String description, @Nullable String workspaceKey, boolean singleton) extends Record
Describes a project resource type contributed by a designer module.
  • Constructor Details

    • DesignerResourceMeta

      public DesignerResourceMeta(@NonNull ResourceType type, @NonNull String title, @NonNull String description, @Nullable String workspaceKey, boolean singleton)
      Creates an instance of a DesignerResourceMeta record class.
      Parameters:
      type - the value for the type record component
      title - the value for the title record component
      description - the value for the description record component
      workspaceKey - the value for the workspaceKey record component
      singleton - the value for the singleton 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.
    • type

      public @NonNull ResourceType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component
    • title

      public @NonNull String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component
    • description

      public @NonNull String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • workspaceKey

      public @Nullable String workspaceKey()
      Returns the value of the workspaceKey record component.
      Returns:
      the value of the workspaceKey record component
    • singleton

      public boolean singleton()
      Returns the value of the singleton record component.
      Returns:
      the value of the singleton record component