Record Class AdocCoordinates

java.lang.Object
java.lang.Record
network.ike.plugin.adoc.AdocCoordinates
Record Components:
groupId - the group, for example network.ike.lab
artifactId - the artifact, for example topics
version - the version the library was declared or found at

public record AdocCoordinates(String groupId, String artifactId, String version) extends Record
The Maven coordinates of a topic library: the artifact that ships a set of packages. The classifier is always adoc and the type always zip, so neither is carried.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The classifier every topic library zip carries.
    static final String
    The reserved area a library's own metadata is under, keyed by its coordinates.
    static final String
    The type every topic library zip carries.
  • Constructor Summary

    Constructors
    Constructor
    Description
    AdocCoordinates(String groupId, String artifactId, String version)
    Checks that every part is present.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the artifactId record component.
    The <dependency> block that declares this library, indented for a module's pom.xml.
    final boolean
    Indicates whether some other object is "equal to" this one.
    ga()
    The group and artifact, group:artifact, which is how a manifest names them.
    gav()
    The full coordinate as a build log prints it, group:artifact:zip:adoc:version.
    Returns the value of the groupId record component.
    final int
    Returns a hash code value for this object.
    The library's manifest inside a zip or the union, relative to the root.
    The library's metadata directory inside a zip or the union, relative to the root: META-INF/ike/<group>/<artifact>.
    final String
    Returns a string representation of this record class.
    Returns the value of the version record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • CLASSIFIER

      public static final String CLASSIFIER
      The classifier every topic library zip carries.
      See Also:
    • TYPE

      public static final String TYPE
      The type every topic library zip carries.
      See Also:
    • META_INF_IKE

      public static final String META_INF_IKE
      The reserved area a library's own metadata is under, keyed by its coordinates.
      See Also:
  • Constructor Details

    • AdocCoordinates

      public AdocCoordinates(String groupId, String artifactId, String version)
      Checks that every part is present.
      Parameters:
      groupId - the group
      artifactId - the artifact
      version - the version
  • Method Details

    • ga

      public String ga()
      The group and artifact, group:artifact, which is how a manifest names them.
      Returns:
      the group and artifact joined by a colon
    • gav

      public String gav()
      The full coordinate as a build log prints it, group:artifact:zip:adoc:version.
      Returns:
      the coordinate with classifier and type
    • metaInfPath

      public String metaInfPath()
      The library's metadata directory inside a zip or the union, relative to the root: META-INF/ike/<group>/<artifact>.
      Returns:
      the relative path, with forward slashes
    • manifestPath

      public String manifestPath()
      The library's manifest inside a zip or the union, relative to the root.
      Returns:
      the relative path of manifest.yaml, with forward slashes
    • dependencyBlock

      public String dependencyBlock()
      The <dependency> block that declares this library, indented for a module's pom.xml. This is what the build prints for an include that nothing declared ships.
      Returns:
      the XML block, eight spaces in, ending with a newline
    • 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.
    • groupId

      public String groupId()
      Returns the value of the groupId record component.
      Returns:
      the value of the groupId record component
    • artifactId

      public String artifactId()
      Returns the value of the artifactId record component.
      Returns:
      the value of the artifactId record component
    • version

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