Verified Owner
Top Description Inners Fields Constructors Methods
org.jabref.logic.citationstyle

public Class CitationStyleCache

extends Object
Class Inheritance
Imports
org.jabref.logic.preview.PreviewLayout, org.jabref.model.database.BibDatabaseContext, org.jabref.model.database.event.EntriesRemovedEvent, org.jabref.model.entry.BibEntry, org.jabref.model.entry.event.EntryChangedEvent, com.github.benmanes.caffeine.cache.Caffeine, .LoadingCache, com.google.common.eventbus.Subscribe, org.jspecify.annotations.NonNull, .Nullable
Caches the generated Citations for quicker access CitationStyleGenerator generates the citation with JavaScript which may take some time

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
CitationStyleCache.BibDatabaseEntryListener

Field Summary

Modifier and TypeField and Description
private static final int
CACHE_SIZE

private @Nullable PreviewLayout
citationStyle

private final LoadingCache<BibEntry, String>
citationStyleCache

Constructor Summary

AccessConstructor and Description
public
CitationStyleCache(BibDatabaseContext databaseContext)

Method Summary

Modifier and TypeMethod and Description
public String
getCitationFor(BibEntry entry)

Returns the citation for the given entry.

public void
setCitationStyle(@NonNull PreviewLayout
The new citation style
citationStyle)

Set a new citation style and invalidate all cached styles

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CACHE_SIZEback to summary
private static final int CACHE_SIZE
citationStyleback to summary
private @Nullable PreviewLayout citationStyle
citationStyleCacheback to summary
private final LoadingCache<BibEntry, String> citationStyleCache

Constructor Detail

CitationStyleCacheback to summary
public CitationStyleCache(BibDatabaseContext databaseContext)

Method Detail

getCitationForback to summary
public String getCitationFor(BibEntry entry)

Returns the citation for the given entry.

setCitationStyleback to summary
public void setCitationStyle(@NonNull PreviewLayout citationStyle)

Set a new citation style and invalidate all cached styles

Parameters
citationStyle:@NonNull PreviewLayout

The new citation style

org.jabref.logic.citationstyle back to summary

private Class CitationStyleCache.BibDatabaseEntryListener

extends Object
Class Inheritance
  • java.lang.Object
  • org.jabref.logic.citationstyle.CitationStyleCache.BibDatabaseEntryListener

Constructor Summary

AccessConstructor and Description
private
BibDatabaseEntryListener()

Method Summary

Modifier and TypeMethod and Description
public void
listen(EntryChangedEvent entryChangedEvent)

removes the outdated citation of the changed entry

public void
listen(EntriesRemovedEvent entriesRemovedEvent)

removes the citation of the removed entries as they are not needed anymore

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

BibDatabaseEntryListenerback to summary
private BibDatabaseEntryListener()

Method Detail

listenback to summary
public void listen(EntryChangedEvent entryChangedEvent)

removes the outdated citation of the changed entry

Annotations
@Subscribe
listenback to summary
public void listen(EntriesRemovedEvent entriesRemovedEvent)

removes the citation of the removed entries as they are not needed anymore

Annotations
@Subscribe