Record Class ConfigResourceBrief

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.config.ai.ConfigResourceBrief
Record Components:
name - the resource name, unique within its type.
description - the resource's user-authored documentation, or null when it has none.
enabled - whether the resource is enabled; a disabled resource is still fully configured but is not running.
extensionPointType - the subtype identifier for resources of an extension point type, matching an ExtensionSubtype.typeId(). null for types that are not extension points, and also when the subtype could not be determined from the stored configuration.

public record ConfigResourceBrief(String name, @Nullable String description, boolean enabled, @Nullable String extensionPointType) extends Record
One resource of a config type, identified but not yet read. The name is what a caller passes back to read the resource's full configuration.
  • Constructor Details

    • ConfigResourceBrief

      public ConfigResourceBrief(String name, @Nullable String description, boolean enabled, @Nullable String extensionPointType)
      Creates an instance of a ConfigResourceBrief record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      enabled - the value for the enabled record component
      extensionPointType - the value for the extensionPointType 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 String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component
    • description

      public @Nullable String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component
    • extensionPointType

      public @Nullable String extensionPointType()
      Returns the value of the extensionPointType record component.
      Returns:
      the value of the extensionPointType record component