Package edu.ucsb.cs156.frontiers.entities

Record Class BranchId

java.lang.Object
java.lang.Record
edu.ucsb.cs156.frontiers.entities.BranchId
@Embeddable public record BranchId(@Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid org name") @NotNull @NotBlank String org, @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid repo name") @NotNull @NotBlank String repo, @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid branch name") @NotNull @NotBlank String branchName) extends Record
Represents a GitHub branch identifier with organization, repository, and branch name. regex pattern is specified to prevent injection into GitHub GraphQL API.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BranchId(@Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid org name") @NotNull @NotBlank String org, @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid repo name") @NotNull @NotBlank String repo, @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid branch name") @NotNull @NotBlank String branchName)
    Creates an instance of a BranchId record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid branch name") @NotNull @NotBlank String
    branchName()
    Returns the value of the branchName record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid org name") @NotNull @NotBlank String
    org()
    Returns the value of the org record component.
    @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid repo name") @NotNull @NotBlank String
    repo()
    Returns the value of the repo record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BranchId

      public BranchId(@Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid org name") @NotNull @NotBlank @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid org name") @NotNull @NotBlank String org, @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid repo name") @NotNull @NotBlank @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid repo name") @NotNull @NotBlank String repo, @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid branch name") @NotNull @NotBlank @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid branch name") @NotNull @NotBlank String branchName)
      Creates an instance of a BranchId record class.
      Parameters:
      org - the value for the org record component
      repo - the value for the repo record component
      branchName - the value for the branchName 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.

    • org

      @Pattern(regexp="^[a-zA-Z0-9._-]+$", message="Invalid org name") @NotNull @NotBlank public @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid org name") @NotNull @NotBlank String org()
      Returns the value of the org record component.
      Returns:
      the value of the org record component

    • repo

      @Pattern(regexp="^[a-zA-Z0-9._-]+$", message="Invalid repo name") @NotNull @NotBlank public @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid repo name") @NotNull @NotBlank String repo()
      Returns the value of the repo record component.
      Returns:
      the value of the repo record component

    • branchName

      @Pattern(regexp="^[a-zA-Z0-9._-]+$", message="Invalid branch name") @NotNull @NotBlank public @Pattern(regexp="^[a-zA-Z0-9._-]+$",message="Invalid branch name") @NotNull @NotBlank String branchName()
      Returns the value of the branchName record component.
      Returns:
      the value of the branchName record component