Verified Owner
Top Fields Constructors Methods
org.jabref.model.openoffice.style

public Class CitationLookupResult

extends Object
Class Inheritance
Imports
java.util.Objects, org.jabref.model.database.BibDatabase, org.jabref.model.entry.BibEntry, org.jspecify.annotations.NonNull

Field Summary

Modifier and TypeField and Description
public final BibDatabase
database

public final BibEntry
entry

Constructor Summary

AccessConstructor and Description
public
CitationLookupResult(@NonNull BibEntry entry, @NonNull BibDatabase database)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object otherObject)

Overrides java.lang.Object.equals.

Consequently, this.database.equals(that.database) below is equivalent to this.database == that.database.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

databaseback to summary
public final BibDatabase database
entryback to summary
public final BibEntry entry

Constructor Detail

CitationLookupResultback to summary
public CitationLookupResult(@NonNull BibEntry entry, @NonNull BibDatabase database)

Method Detail

equalsback to summary
public boolean equals(Object otherObject)

Overrides java.lang.Object.equals.

Note

BibEntry overrides Object.equals, but BibDatabase does not.

Consequently, this.database.equals(that.database) below is equivalent to this.database == that.database.

Since within each GUI call we use a fixed list of databases, it is OK.

CitationLookupResult.equals is used in CitedReference.addPath to check the added Citation refers to the same source as the others. As long as we look up each citation key only once (in CitationGroups.lookupCitations), the default implementation for equals would be sufficient (and could also omit hashCode below).

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override