Record Class SiteContext

java.lang.Object
java.lang.Record
network.ike.plugin.reconcile.SiteContext
Record Components:
gitRoot - the git root of the project whose site is being reconciled
projectId - the project's Maven artifact id
projectVersion - the current POM version (SNAPSHOT stripped where relevant)
projectName - the human-readable project name (POM <name>) or null
projectDescription - the project description (POM <description>) or null
projectSiteUrl - the canonical site URL (e.g. https://ike.network/ike-tooling/)
githubUrl - the project's GitHub repository URL
srcRepoUrl - git URL of the org-site SOURCE repo
srcBranch - branch in the org-site source repo
pubRepoUrl - git URL of the org-site PUBLISH repo
pubBranch - branch in the org-site publish repo
options - user-supplied flag values
log - Maven logger for reconciler output
public record SiteContext(File gitRoot, String projectId, String projectVersion, String projectName, String projectDescription, String projectSiteUrl, String githubUrl, String srcRepoUrl, String srcBranch, String pubRepoUrl, String pubBranch, SiteReconcilerOptions options, org.apache.maven.api.plugin.Log log) extends Record
Context handed to each SiteReconciler for detect and apply. Bundles the per-repo identity (git root, artifact id, project version), org-site coordinates, user-supplied flags, and a logger.

Parallels network.ike.plugin.ws.reconcile.WorkspaceContext but at the per-repo scope rather than the workspace-wide scope. The two are intentionally kept separate — see SiteReconciler for the rationale.

  • Constructor Details

    • SiteContext

      public SiteContext(File gitRoot, String projectId, String projectVersion, String projectName, String projectDescription, String projectSiteUrl, String githubUrl, String srcRepoUrl, String srcBranch, String pubRepoUrl, String pubBranch, SiteReconcilerOptions options, org.apache.maven.api.plugin.Log log)
      Creates an instance of a SiteContext record class.
      Parameters:
      gitRoot - the value for the gitRoot record component
      projectId - the value for the projectId record component
      projectVersion - the value for the projectVersion record component
      projectName - the value for the projectName record component
      projectDescription - the value for the projectDescription record component
      projectSiteUrl - the value for the projectSiteUrl record component
      githubUrl - the value for the githubUrl record component
      srcRepoUrl - the value for the srcRepoUrl record component
      srcBranch - the value for the srcBranch record component
      pubRepoUrl - the value for the pubRepoUrl record component
      pubBranch - the value for the pubBranch record component
      options - the value for the options record component
      log - the value for the log 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.

    • gitRoot

      public File gitRoot()
      Returns the value of the gitRoot record component.
      Returns:
      the value of the gitRoot record component

    • projectId

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

    • projectVersion

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

    • projectName

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

    • projectDescription

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

    • projectSiteUrl

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

    • githubUrl

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

    • srcRepoUrl

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

    • srcBranch

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

    • pubRepoUrl

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

    • pubBranch

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

    • options

      public SiteReconcilerOptions options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component

    • log

      public org.apache.maven.api.plugin.Log log()
      Returns the value of the log record component.
      Returns:
      the value of the log record component