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

public final Record MergePlan

extends Record
Class Inheritance
Record Components
fieldPatches:Map<String, Map<Field, String>>
contains field-level modifications per citation key. citationKey -> field -> newValue (null = delete)
newEntries:List<BibEntry>
entries present in remote but not in base/local
deletedEntryKeys:List<String> 
Imports
java.util.List, .Map, org.jabref.model.entry.BibEntry, org.jabref.model.entry.field.Field
A data structure representing the result of semantic diffing between base and remote entries.

The idea is: library A and then this patch leads to library B (if this patch is calculated between A and B) This is a bit different from org.jabref.logic.bibtex.comparator.BibEntryDiff, which "just" contains two entries on any field diff, but leaves "computation" on the caller. Thus, the data structure is different, because here, only the patches are contained, not any source or target. "patch" in the sense of "commands" to be applied to the source to get the target

Field Summary

Modifier and TypeField and Description
private final List<String>
deletedEntryKeys

Record Component accessed by deletedEntryKeys().

private final Map<String, Map<Field, String>>
fieldPatches

Record Component accessed by fieldPatches().

contains field-level modifications per citation key.
private final List<BibEntry>
newEntries

Record Component accessed by newEntries().

entries present in remote but not in base/local

Constructor Summary

AccessConstructor and Description
public
MergePlan(Map<String, Map<Field, String>> fieldPatches, List<BibEntry> newEntries, List<String> deletedEntryKeys)

Method Summary

Modifier and TypeMethod and Description
public List<String>
deletedEntryKeys()

Record Component getter of deletedEntryKeys.

public static MergePlan
empty()

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

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

public Map<String, Map<Field, String>>
fieldPatches()

Record Component getter of fieldPatches.

Record Component contains field-level modifications per citation key.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public boolean
isEmpty()

public List<BibEntry>
newEntries()

Record Component getter of newEntries.

Record Component entries present in remote but not in base/local

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

deletedEntryKeysback to summary
private final List<String> deletedEntryKeys

Record Component accessed by deletedEntryKeys().

fieldPatchesback to summary
private final Map<String, Map<Field, String>> fieldPatches

Record Component accessed by fieldPatches().

contains field-level modifications per citation key. citationKey -> field -> newValue (null = delete)

newEntriesback to summary
private final List<BibEntry> newEntries

Record Component accessed by newEntries().

entries present in remote but not in base/local

Constructor Detail

MergePlanback to summary
public MergePlan(Map<String, Map<Field, String>> fieldPatches, List<BibEntry> newEntries, List<String> deletedEntryKeys)

Method Detail

deletedEntryKeysback to summary
public List<String> deletedEntryKeys()

Record Component getter of deletedEntryKeys.

emptyback to summary
public static MergePlan empty()
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).
fieldPatchesback to summary
public Map<String, Map<Field, String>> fieldPatches()

Record Component getter of fieldPatches.

Record Component
contains field-level modifications per citation key. citationKey -> field -> newValue (null = delete)
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.

isEmptyback to summary
public boolean isEmpty()
newEntriesback to summary
public List<BibEntry> newEntries()

Record Component getter of newEntries.

Record Component
entries present in remote but not in base/local
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.