Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.git.io

public final Record RevisionTriple

extends Record
Class Inheritance
Annotations
@NullMarked
Record Components
base:Optional<RevCommit>
the merge base (common ancestor of local and remote)
local:RevCommit
the current local branch tip
remote:RevCommit
the tip of the remote tracking branch (typically origin/main)
Imports
java.util.Optional, org.eclipse.jgit.revwalk.RevCommit, org.jspecify.annotations.NullMarked
Holds the three relevant commits involved in a semantic three-way merge, it is a helper value object used exclusively during merge resolution, not part of the domain model

Field Summary

Modifier and TypeField and Description
private final Optional<RevCommit>
base

Record Component accessed by base().

the merge base (common ancestor of local and remote)
private final RevCommit
local

Record Component accessed by local().

the current local branch tip
private final RevCommit
remote

Record Component accessed by remote().

the tip of the remote tracking branch (typically origin/main)

Constructor Summary

AccessConstructor and Description
public
RevisionTriple(Optional<RevCommit> base, RevCommit local, RevCommit remote)

Method Summary

Modifier and TypeMethod and Description
public Optional<RevCommit>
base()

Record Component getter of base.

Record Component the merge base (common ancestor of local and remote)

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public RevCommit
local()

Record Component getter of local.

Record Component the current local branch tip

public RevCommit
remote()

Record Component getter of remote.

Record Component the tip of the remote tracking branch (typically origin/main)

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

baseback to summary
private final Optional<RevCommit> base

Record Component accessed by base().

the merge base (common ancestor of local and remote)

localback to summary
private final RevCommit local

Record Component accessed by local().

the current local branch tip

remoteback to summary
private final RevCommit remote

Record Component accessed by remote().

the tip of the remote tracking branch (typically origin/main)

Constructor Detail

RevisionTripleback to summary
public RevisionTriple(Optional<RevCommit> base, RevCommit local, RevCommit remote)

Method Detail

baseback to summary
public Optional<RevCommit> base()

Record Component getter of base.

Record Component
the merge base (common ancestor of local and remote)
equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

localback to summary
public RevCommit local()

Record Component getter of local.

Record Component
the current local branch tip
remoteback to summary
public RevCommit remote()

Record Component getter of remote.

Record Component
the tip of the remote tracking branch (typically origin/main)
toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.