Record Class SemanticVersion.BuildIdentifier

java.lang.Object
java.lang.Record
xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.BuildIdentifier
Record Components:
value - The build identifier string value.
Enclosing class:
SemanticVersion
public static record SemanticVersion.BuildIdentifier(String value) extends Record
A build metadata identifier.

Identifiers are simply retained as a raw string but must only contain alphanumeric characters and hyphens.

Per the Semantic Versioning (SemVer) specification, build metadata identifiers must not be empty.

  • Constructor Details

    • BuildIdentifier

      public BuildIdentifier(String value)
      Construct the build metadata identifier.

      Build identifiers must not be empty so this constructor enforces that by ensuring the given value is non-empty.

      This constructor also enforces the character set requirements for the build identifier.

      Parameters:
      value - The build metadata value.

  • Method Details

    • buildMetadata

      public static @NonNull SemanticVersion.BuildIdentifier buildMetadata(String value)
      A static sugar for BuildIdentifier(String).
      Parameters:
      value - The build identifier value.
      Returns:
      The created build identifier.

    • toString

      public @NonNull 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.

    • value

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