JabRef 6.0-beta.1 · org.jabref.logic.relatedwork.RelatedWorkMatchResult

Field Summary

Modifier and Type	Field and Description
private final String	citationKey Record Component accessed by citationKey().
private final String	contextText Record Component accessed by contextText().
private final Optional<BibEntry>	matchedLibraryBibEntry Record Component accessed by matchedLibraryBibEntry().
private final Optional<BibEntry>	parsedReference Record Component accessed by parsedReference().

Constructor Summary

Access	Constructor and Description
public	RelatedWorkMatchResult(String contextText, String citationKey, Optional<BibEntry> parsedReference, Optional<BibEntry> matchedLibraryBibEntry)

Method Summary

Modifier and Type	Method and Description
public String	citationKey() Record Component getter of citationKey.
public String	contextText() Record Component getter of contextText.
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 boolean	hasMatchedLibraryEntry()
public Optional<BibEntry>	matchedLibraryBibEntry() Record Component getter of matchedLibraryBibEntry.
public Optional<BibEntry>	parsedReference() Record Component getter of parsedReference.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

citationKey	back to summary
private final String citationKey Record Component accessed by citationKey().

contextText	back to summary
private final String contextText Record Component accessed by contextText().

matchedLibraryBibEntry	back to summary
private final Optional<BibEntry> matchedLibraryBibEntry Record Component accessed by matchedLibraryBibEntry().

parsedReference	back to summary
private final Optional<BibEntry> parsedReference Record Component accessed by parsedReference().

Constructor Detail

RelatedWorkMatchResult	back to summary
public RelatedWorkMatchResult(String contextText, String citationKey, Optional<BibEntry> parsedReference, Optional<BibEntry> matchedLibraryBibEntry)

Method Detail

citationKey	back to summary
public String citationKey() Record Component getter of citationKey.

contextText	back to summary
public String contextText() Record Component getter of contextText.

equals back to summary

equals	back 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)`.

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).

hashCode back to summary

hashCode	back 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.

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.

hasMatchedLibraryEntry	back to summary
public boolean hasMatchedLibraryEntry()

matchedLibraryBibEntry	back to summary
public Optional<BibEntry> matchedLibraryBibEntry() Record Component getter of matchedLibraryBibEntry.

parsedReference	back to summary
public Optional<BibEntry> parsedReference() Record Component getter of parsedReference.

toString back to summary

toString	back 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.

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.