Package com.inductiveautomation.ignition.common.script

Record Class PackageTreeNode

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.script.PackageTreeNode
public record PackageTreeNode(String name, Map<String,PackageTreeNode> children, List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Attribute> attributes, List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method> methods) extends Record
An immutable tree element that represents a particular system library package (e.g. 'system.util' under 'system').

  • Constructor Summary

    Constructors
    Constructor
    Description
    PackageTreeNode(String name, Map<String,PackageTreeNode> children, List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Attribute> attributes, List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method> methods)
    Creates an instance of a PackageTreeNode record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Attribute>
    attributes()
    Returns the value of the attributes record component.
    Map<String,PackageTreeNode>
    children()
    Returns the value of the children record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method>
    methods()
    Returns the value of the methods record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PackageTreeNode

      public PackageTreeNode(String name, Map<String,PackageTreeNode> children, List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Attribute> attributes, List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method> methods)
      Creates an instance of a PackageTreeNode record class.
      Parameters:
      name - the value for the name record component
      children - the value for the children record component
      attributes - the value for the attributes record component
      methods - the value for the methods 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. 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • children

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

    • attributes

      public List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Attribute> attributes()
      Returns the value of the attributes record component.
      Returns:
      the value of the attributes record component

    • methods

      public List<com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method> methods()
      Returns the value of the methods record component.
      Returns:
      the value of the methods record component