Package com.inductiveautomation.ignition.gateway.web.nav

Record Class Category

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.web.nav.Category
All Implemented Interfaces:
Comparable<Category>
public record Category(String key, String label, @Nullable PermissionType requiredPermission, @Nullable Mount mount, @Nullable ItemSearchDelegate searchDelegate, Set<ResourceType> associatedResourceTypes, int position, List<Page> pages) extends Record implements Comparable<Category>

  • Constructor Details

    • Category

      public Category(String key, String label, @Nullable PermissionType requiredPermission, @Nullable Mount mount, @Nullable ItemSearchDelegate searchDelegate, Set<ResourceType> associatedResourceTypes, int position, List<Page> pages)
      Creates an instance of a Category record class.
      Parameters:
      key - the value for the key record component
      label - the value for the label record component
      requiredPermission - the value for the requiredPermission record component
      mount - the value for the mount record component
      searchDelegate - the value for the searchDelegate record component
      associatedResourceTypes - the value for the associatedResourceTypes record component
      position - the value for the position record component
      pages - the value for the pages record component

  • Method Details

    • merge

      public Category merge(Category other)

    • mounts

      public Stream<Mount> mounts()

    • compareTo

      public int compareTo(@NotNull @NotNull Category that)
      Specified by:
      compareTo in interface Comparable<Category>

    • 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 '=='.
      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.

    • key

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

    • label

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

    • requiredPermission

      @Nullable public PermissionType requiredPermission()
      Returns the value of the requiredPermission record component.
      Returns:
      the value of the requiredPermission record component

    • mount

      @Nullable public Mount mount()
      Returns the value of the mount record component.
      Returns:
      the value of the mount record component

    • searchDelegate

      @Nullable public ItemSearchDelegate searchDelegate()
      Returns the value of the searchDelegate record component.
      Returns:
      the value of the searchDelegate record component

    • associatedResourceTypes

      public Set<ResourceType> associatedResourceTypes()
      Returns the value of the associatedResourceTypes record component.
      Returns:
      the value of the associatedResourceTypes record component

    • position

      public int position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • pages

      public List<Page> pages()
      Returns the value of the pages record component.
      Returns:
      the value of the pages record component