Record Class ChangeManifest.ChangeEntity

java.lang.Object
java.lang.Record
network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Record Components:
id - stable kebab-case identifier
title - short human title (used as glossary term and change-index entry)
description - one-or-two-sentence reviewable description
refs - issue references, e.g. IKE-Network/ike-issues#648
files - repository-relative files the change touches
Enclosing class:
ChangeManifest
public static record ChangeManifest.ChangeEntity(String id, String title, String description, List<String> refs, List<String> files) extends Record
One named change.

  • Constructor Details

    • ChangeEntity

      public ChangeEntity(String id, String title, String description, List<String> refs, List<String> files)
      Creates an instance of a ChangeEntity record class.
      Parameters:
      id - the value for the id record component
      title - the value for the title record component
      description - the value for the description record component
      refs - the value for the refs record component
      files - the value for the files 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.

    • id

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

    • title

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

    • description

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

    • refs

      public List<String> refs()
      Returns the value of the refs record component.
      Returns:
      the value of the refs record component

    • files

      public List<String> files()
      Returns the value of the files record component.
      Returns:
      the value of the files record component