Record Class FragmentTemplateEngine.TemplateInfo

java.lang.Object
java.lang.Record
aQute.bnd.wstemplates.FragmentTemplateEngine.TemplateInfo
All Implemented Interfaces:
Comparable<FragmentTemplateEngine.TemplateInfo>
Enclosing class:
FragmentTemplateEngine
public static record FragmentTemplateEngine.TemplateInfo(TemplateID id, String name, String description, String[] require, String[] tag) extends Record implements Comparable<FragmentTemplateEngine.TemplateInfo>
Info about a template, comes from the index files.

  • Constructor Details

    • TemplateInfo

      public TemplateInfo(TemplateID id, String name, String description, String[] require, String... tag)
      Creates an instance of a TemplateInfo record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      description - the value for the description record component
      require - the value for the require record component
      tag - the value for the tag record component

  • Method Details

    • compareTo

      public int compareTo(FragmentTemplateEngine.TemplateInfo o)
      Specified by:
      compareTo in interface Comparable<FragmentTemplateEngine.TemplateInfo>

    • isOfficial

      public boolean isOfficial()
      Returns:
      true if this template is from the github bndtools organisation, which we consider "officially provided by us".

    • isCommitSHA

      public boolean isCommitSHA()
      Check if the id points to a specific commit SHA e.g. githuborg/myrepo/subfolder/workspace-template#b96e0a8877bad1c68cdc050d5854829253ef63bb In this case b96e0a8877bad1c68cdc050d5854829253ef63bb would be the SHA.
      Returns:
      true if the repoUrl points to a specific commit SHA.

    • 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 TemplateID id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • name

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

    • description

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

    • require

      public String[] require()
      Returns the value of the require record component.
      Returns:
      the value of the require record component

    • tag

      public String[] tag()
      Returns the value of the tag record component.
      Returns:
      the value of the tag record component