JabRef 6.0-beta.1 · org.jabref.http.dto.LibraryQueryMatch

A single entry that matched a query, identified by its library and citation key.

entryId is the entry's citation key. Because citation keys are optional in the underlying model, entries without a key are reported with the sentinel UNSET_CITATION_KEY ({NONE}) instead of an empty string. The sentinel uses curly braces deliberately: { and } are reserved in the BibTeX grammar (group delimiters in field values) and can never appear inside a real citation key, so the sentinel is guaranteed not to collide with a valid key. Other "obvious" markers such as <NONE> are not safe — Pandoc, for example, allows < and > in citation keys.

Callers cannot distinguish multiple unkeyed entries from one another via this DTO — fix the library by assigning citation keys if disambiguation is required.

Field Summary

Modifier and Type	Field and Description
private final String	entryId Record Component accessed by entryId().
private final String	libraryId Record Component accessed by libraryId().
public static final String	UNSET_CITATION_KEY

Constructor Summary

Access	Constructor and Description
public	LibraryQueryMatch(String libraryId, String entryId)

Method Summary

Modifier and Type	Method and Description
public String	entryId() Record Component getter of entryId.
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 String	libraryId() Record Component getter of libraryId.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

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

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

UNSET_CITATION_KEY	back to summary
public static final String UNSET_CITATION_KEY

Constructor Detail

LibraryQueryMatch	back to summary
public LibraryQueryMatch(String libraryId, String entryId)

Method Detail

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

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.

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

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.