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

public Class JabRefCliPreferences

extends Object
implements CliPreferences
Class Inheritance
All Implemented Interfaces
org.jabref.logic.preferences.CliPreferences
Annotations
@Singleton
Imports
java.io.IOException, .InputStream, .OutputStream, java.nio.file.Files, .Path, java.util.ArrayList, .Arrays, .Collection, .EnumSet, .HashMap, .HashSet, .List, .Locale, .Map, .Objects, .Optional, .SequencedSet, .Set, .TreeSet, java.util.function.BooleanSupplier, .Consumer, .Function, .Supplier, java.util.prefs.BackingStoreException, .InvalidPreferencesFormatException, .Preferences, java.util.stream.Collectors, javafx.beans.InvalidationListener, .Observable, javafx.beans.property.BooleanProperty, .DoubleProperty, .IntegerProperty, .ObjectProperty, .Property, .StringProperty, javafx.beans.value.ChangeListener, javafx.collections.ListChangeListener, .MapChangeListener, .ObservableList, .ObservableMap, .ObservableSet, org.jabref.logic.FilePreferences, .InternalPreferences, .JabRefException, .LibraryPreferences, org.jabref.logic.ai.preferences.AiPreferences, org.jabref.logic.bibtex.FieldPreferences, org.jabref.logic.citationkeypattern.CitationKeyPattern, .CitationKeyPatternPreferences, .GlobalCitationKeyPatterns, org.jabref.logic.citationstyle.CSLStyleLoader, .CSLStyleUtils, org.jabref.logic.cleanup.CleanupPreferences, .FieldFormatterCleanupActions, .FieldFormatterCleanupMapper, org.jabref.logic.exporter.BibDatabaseWriter, .ExportPreferences, .MetaDataSerializer, .SelfContainedSaveConfiguration, .TemplateExporter, org.jabref.logic.git.preferences.GitPreferences, org.jabref.logic.importer.ImportException, .ImporterPreferences, org.jabref.logic.importer.fileformat.CustomImporter, org.jabref.logic.importer.plaincitation.PlainCitationParserChoice, org.jabref.logic.importer.util.GrobidPreferences, .MetaDataParser, org.jabref.logic.journals.AbbreviationPreferences, .JournalAbbreviationLoader, .JournalAbbreviationRepository, org.jabref.logic.l10n.Language, .Localization, org.jabref.logic.layout.LayoutFormatterPreferences, org.jabref.logic.layout.format.NameFormatterPreferences, org.jabref.logic.net.ProxyPreferences, org.jabref.logic.net.ssl.SSLPreferences, .TrustStoreManager, org.jabref.logic.ocr.EngineSelection, .OcrLanguage, .OcrPreferences, .PagesWithTextHandling, org.jabref.logic.openoffice.OpenOfficePreferences, org.jabref.logic.openoffice.style.BstCitationFormat, .BstStyle, .JStyle, .OOStyle, org.jabref.logic.os.OS, org.jabref.logic.protectedterms.ProtectedTermsPreferences, org.jabref.logic.push.CitationCommandString, .PushApplications, .PushToApplicationPreferences, org.jabref.logic.remote.RemotePreferences, org.jabref.logic.search.SearchPreferences, org.jabref.logic.shared.prefs.SharedDatabasePreferences, org.jabref.logic.shared.security.Password, org.jabref.logic.util.Version, org.jabref.logic.util.io.AutoLinkPreferences, .FileHistory, org.jabref.logic.util.strings.StringUtil, org.jabref.logic.xmp.XmpPreferences, org.jabref.model.ai.llm.AiProvider, org.jabref.model.ai.pipeline.DocumentSplitterKind, .ResponseEngineKind, org.jabref.model.ai.summarization.SummarizatorKind, org.jabref.model.ai.tokenization.TokenEstimatorKind, org.jabref.model.database.BibDatabaseMode, org.jabref.model.entry.BibEntryPreferences, .BibEntryType, .BibEntryTypesManager, org.jabref.model.entry.field.Field, .FieldFactory, org.jabref.model.entry.types.EntryType, .EntryTypeFactory, org.jabref.model.metadata.SaveOrder, .SelfContainedSaveOrder, org.jabref.model.openoffice.style.CitationType, org.jabref.model.search.SearchDisplayMode, .SearchFlags, com.github.javakeyring.Keyring, .PasswordAccessException, com.google.common.annotations.VisibleForTesting, com.google.common.base.Splitter, com.tobiasdiez.easybind.EasyBind, jakarta.inject.Singleton, org.jspecify.annotations.NonNull, .Nullable, org.slf4j.Logger, .LoggerFactory
The JabRefPreferences class provides the preferences and their defaults using the JDK java.util.prefs class.

Internally it defines symbols used to pick a value from the java.util.prefs interface and keeps a hashmap with all the default values.

There are still some similar preferences classes (OpenOfficePreferences and SharedDatabasePreferences) which also use the java.util.prefs API.

contents of the defaults HashMap that are defined in this class. There are more default parameters in this map which belong to separate preference classes.

This class is injected into formatter using reflection to avoid tight coupling and is easier than injecting via constructor due to amount of refactoring

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static record
JabRefCliPreferences.KeyringSlot

Identifies a single secret in the system keyring by its service and account.

private static record
JabRefCliPreferences.PreferenceBinding

Field Summary

Modifier and TypeField and Description
private AbbreviationPreferences
abbreviationPreferences

private static final String
AI_ANSWER_ENGINE_KIND

private static final String
AI_AUTO_GENERATE_EMBEDDINGS

private static final String
AI_AUTO_GENERATE_SUMMARIES

private static final String
AI_CHATTING_SYSTEM_MESSAGE_TEMPLATE

private static final String
AI_CHATTING_USER_MESSAGE_TEMPLATE

private static final String
AI_CITATION_PARSING_SYSTEM_MESSAGE_TEMPLATE

private static final String
AI_CONTEXT_WINDOW_SIZE

private static final String
AI_CUSTOMIZE_SETTINGS

private static final String
AI_DOCUMENT_SPLITTER_CHUNK_SIZE

private static final String
AI_DOCUMENT_SPLITTER_KIND

private static final String
AI_DOCUMENT_SPLITTER_OVERLAP_SIZE

private static final String
AI_EMBEDDING_MODEL

private static final String
AI_ENABLED

private static final String
AI_FOLLOW_UP_QUESTIONS_COUNT

private static final String
AI_FOLLOW_UP_QUESTIONS_TEMPLATE

private static final String
AI_GEMINI_API_BASE_URL

private static final String
AI_GEMINI_CHAT_MODEL

private static final String
AI_GENERATE_FOLLOW_UP_QUESTIONS

private static final String
AI_HUGGING_FACE_API_BASE_URL

private static final String
AI_HUGGING_FACE_CHAT_MODEL

private static final String
AI_MARKDOWN_CHAT_EXPORT_TEMPLATE

private static final String
AI_MISTRAL_AI_API_BASE_URL

private static final String
AI_MISTRAL_AI_CHAT_MODEL

private static final String
AI_OPEN_AI_API_BASE_URL

private static final String
AI_OPEN_AI_CHAT_MODEL

private static final String
AI_PROVIDER

private static final String
AI_RAG_MAX_RESULTS_COUNT

private static final String
AI_RAG_MIN_SCORE

private static final String
AI_RESPONSE_ENGINE_KIND

private static final String
AI_SUMMARIZATION_CHUNK_SYSTEM_MESSAGE_TEMPLATE

private static final String
AI_SUMMARIZATION_COMBINE_SYSTEM_MESSAGE_TEMPLATE

private static final String
AI_SUMMARIZATION_FULL_DOCUMENT_SYSTEM_MESSAGE_TEMPLATE

private static final String
AI_SUMMARIZATOR_KIND

private static final String
AI_TEMPERATURE

private static final String
AI_TOKEN_ESTIMATOR_KIND

private AiPreferences
aiPreferences

private final List<JabRefCliPreferences.PreferenceBinding>
allBindings

public static final String
ASK_AUTO_NAMING_PDFS_AGAIN

private AutoLinkPreferences
autoLinkPreferences

private static final String
BACKUP_DIRECTORY

private static final String
BACKUP_ENABLED

private BibEntryPreferences
bibEntryPreferences

public static final String
CITATION_KEY_AVOID_OVERWRITING

public static final String
CITATION_KEY_DEFAULT_PATTERN

public static final String
CITATION_KEY_GEN_ALWAYS_ADD_LETTER

public static final String
CITATION_KEY_GEN_FIRST_LETTER_A

public static final String
CITATION_KEY_GENERATE_BEFORE_SAVING

public static final String
CITATION_KEY_PATTERN_REGEX

public static final String
CITATION_KEY_PATTERN_REPLACEMENT

public static final String
CITATION_KEY_PATTERNS_NODE

public static final String
CITATION_KEY_TRANSLITERATE_FIELDS

public static final String
CITATION_KEY_UNWANTED_CHARACTERS

public static final String
CITATION_KEY_WARN_BEFORE_OVERWRITE

private CitationKeyPatternPreferences
citationKeyPatternPreferences

public static final String
CLEANUP_FIELD_FORMATTERS

public static final String
CLEANUP_FIELD_FORMATTERS_ENABLED

public static final String
CLEANUP_JOBS

private CleanupPreferences
cleanupPreferences

public static final String
CUSTOM_EXPORT_FORMAT

public static final String
CUSTOMIZED_BIBLATEX_TYPES

public static final String
CUSTOMIZED_BIBLATEX_TYPES_V2

public static final String
CUSTOMIZED_BIBTEX_TYPES

public static final String
CUSTOMIZED_BIBTEX_TYPES_V2

public static final String
DO_NOT_RESOLVE_STRINGS

public static final String
DOI_BASE_URI

public static final String
DOI_USE_CUSTOM_URI

private DOIPreferences
doiPreferences

public static final String
DUPLICATE_RESOLVER_DECISION_RESULT_ALL_ENTRIES

private static final String
ENABLE_MSC_KEYWORD_DESCRIPTIONS

public static final String
EXPORT_IN_ORIGINAL_ORDER

public static final String
EXPORT_IN_SPECIFIED_ORDER

public static final String
EXPORT_PRIMARY_SORT_DESCENDING

public static final String
EXPORT_PRIMARY_SORT_FIELD

public static final String
EXPORT_SECONDARY_SORT_DESCENDING

public static final String
EXPORT_SECONDARY_SORT_FIELD

public static final String
EXPORT_TERTIARY_SORT_DESCENDING

public static final String
EXPORT_TERTIARY_SORT_FIELD

public static final String
EXPORT_WORKING_DIRECTORY

private static final int
EXPORTER_EXTENSION_INDEX

private static final int
EXPORTER_FILENAME_INDEX

private static final int
EXPORTER_NAME_INDEX

private ExportPreferences
exportPreferences

private static final String
EXTERNAL_JOURNAL_LISTS

private static final String
FETCHER_CUSTOM_KEY_NAMES

private static final String
FETCHER_CUSTOM_KEY_PERSIST

private static final String
FETCHER_CUSTOM_KEY_USES

private FieldPreferences
fieldPreferences

private FilePreferences
filePreferences

private static final String
FILES_AUTO_RENAME_ON_CHANGE

private static final String
FILES_CONFIRM_DELETE_LINKED

private static final String
FILES_COPY_LINKED_FILES_ON_TRANSFER

private static final String
FILES_DOWNLOAD_LINKED

private static final String
FILES_FULLTEXT_INDEX

private static final String
FILES_IMPORT_DIRPATTERN

private static final String
FILES_IMPORT_NAMEPATTERN

private static final String
FILES_KEEP_DOWNLOAD_URL

private static final String
FILES_LAST_USED_DIRECTORY

private static final String
FILES_MAIN_DIRECTORY

private static final String
FILES_MOVE_LINKED_FILES_ON_TRANSFER

private static final String
FILES_OPEN_FILE_EXPLORER_IN_FILE_DIRECTORY

private static final String
FILES_OPEN_FILE_EXPLORER_IN_LAST_USED_DIRECTORY

private static final String
FILES_STORE_RELATIVE_TO_BIB

private static final String
FILES_TRASH_INSTEAD_OF_DELETE

private static final String
FILES_WORKING_DIRECTORY

private static final String
GIT_PULL_INTERVAL_KEY

private static final String
GITHUB_PAT_KEY

private static final String
GITHUB_REMEMBER_PAT_KEY

private static final String
GITHUB_REMOTE_URL_KEY

private static final String
GITHUB_USERNAME_KEY

private GitPreferences
gitPreferences

public static final String
GROBID_ENABLED

public static final String
GROBID_PREFERENCE

public static final String
GROBID_URL

private GrobidPreferences
grobidPreferences

public static final String
IMPORT_KEYWORD_DELIMITER_PARSING_STRATEGY

public static final String
IMPORT_KEYWORD_DELIMITERS

private static final String
IMPORTER_CATALOGS

private static final String
IMPORTER_CITATIONS_RELATIONS_STORE_TTL

private static final String
IMPORTER_CUSTOM_FORMAT

private static final String
IMPORTER_DEFAULT_PLAIN_CITATION_PARSER

private static final String
IMPORTER_ENABLED

private static final String
IMPORTER_GENERATE_KEY_ON_IMPORT

private static final String
IMPORTER_WARN_ABOUT_DUPLICATES

private static final String
IMPORTER_WORKING_DIRECTORY

private ImporterPreferences
importerPreferences

private InternalPreferences
internalPreferences

public static final String
KEYWORD_SEPARATOR

public static final String
LANGUAGE

private static final String
LAST_EDITED

private static final String
LAST_FOCUSED

private static final String
LAST_SHARED_DATABASES

public static final String
LAST_USED_EXPORT

private LastFilesOpenedPreferences
lastFilesOpenedPreferences

public static final String
LIBRARY_ADD_IMPORTED_ENTRIES

public static final String
LIBRARY_ADD_IMPORTED_ENTRIES_GROUP_NAME

public static final String
LIBRARY_AUTO_SAVE

public static final String
LIBRARY_BIBLATEX_DEFAULT_MODE

public static final String
LIBRARY_REFORMAT_ON_SAVE_AND_EXPORT

private LibraryPreferences
libraryPreferences

Cache variables

private static final Logger
LOGGER

public static final String
MEMORY_STICK_MODE

public static final String
MERGE_APPLY_TO_ALL_ENTRIES

public static final String
MERGE_ENTRIES_DIFF_MODE

public static final String
MERGE_ENTRIES_HIGHLIGHT_WORDS

public static final String
MERGE_ENTRIES_SHOULD_SHOW_DIFF

public static final String
MERGE_ENTRIES_SHOULD_SHOW_UNIFIED_DIFF

public static final String
MERGE_SHOW_ONLY_CHANGED_FIELDS

public static final String
NAME_FORMATER_KEY

public static final String
NAME_FORMATTER_VALUE

private NameFormatterPreferences
nameFormatterPreferences

public static final String
NON_WRAPPABLE_FIELDS

private static final String
OCR_ENGINE_PATH

private static final String
OCR_ENGINE_SELECTION

private static final String
OCR_LANGUAGES

private OcrPreferences
ocrPreferences

public static final String
OO_ADD_SPACE_AFTER

public static final String
OO_ADD_SPACE_BEFORE

public static final String
OO_ALWAYS_ADD_CITED_ON_PAGES

public static final String
OO_BIBLIOGRAPHY_STYLE_FILE

public static final String
OO_BST_CITATION_FORMAT

public static final String
OO_CITE_SPECIAL_CITATION_TYPE

public static final String
OO_CSL_BIBLIOGRAPHY_BODY_FORMAT

public static final String
OO_CSL_BIBLIOGRAPHY_HEADER_FORMAT

public static final String
OO_CSL_BIBLIOGRAPHY_TITLE

public static final String
OO_CURRENT_STYLE

public static final String
OO_EXECUTABLE_PATH

The OpenOffice/LibreOffice connection preferences are: OO_PATH main directory for OO/LO installation, used to detect location on Win/macOS when using manual connect OO_EXECUTABLE_PATH path to soffice-file OO_JARS_PATH directory that contains juh.jar, jurt.jar, ridl.jar, unoil.jar OO_SYNC_WHEN_CITING true if the reference list is updated when adding a new citation OO_SHOW_PANEL true if the OO panel is shown on startup OO_USE_ALL_OPEN_DATABASES true if all databases should be used when citing OO_BIBLIOGRAPHY_STYLE_FILE path to the used style file OO_EXTERNAL_STYLE_FILES list with paths to external style files STYLES__ size and position of "Select style" dialog

public static final String
OO_EXTERNAL_BST_STYLES

public static final String
OO_EXTERNAL_CSL_STYLES

public static final String
OO_EXTERNAL_STYLE_FILES

public static final String
OO_INFER_CSL_STYLE_FROM_DOCUMENT

public static final String
OO_PANDOC_PATH

public static final String
OO_SYNC_WHEN_CITING

public static final String
OO_USE_ALL_OPEN_BASES

public static final String
OO_ZOTERO_COMPATIBILITY_MODE

private OpenOfficePreferences
openOfficePreferences

public static final String
OWNER_DEFAULT

public static final String
OWNER_ENABLE

public static final String
OWNER_OVERWRITE

private OwnerPreferences
ownerPreferences

private static final String
PAGES_WITH_TEXT

private static final String
PREFS_EXPORT_PATH

private static final Preferences
PREFS_NODE

private static final String
PROTECTED_TERMS_DISABLED_EXTERNAL

private static final String
PROTECTED_TERMS_DISABLED_INTERNAL

private static final String
PROTECTED_TERMS_ENABLED_EXTERNAL

private static final String
PROTECTED_TERMS_ENABLED_INTERNAL

private ProtectedTermsPreferences
protectedTermsPreferences

private static final String
PROXY_HOSTNAME

private static final String
PROXY_PERSIST_PASSWORD

private static final String
PROXY_PORT

private static final String
PROXY_USE

private static final String
PROXY_USE_AUTHENTICATION

private static final String
PROXY_USERNAME

private ProxyPreferences
proxyPreferences

private static final Map<PushApplications, String>
PUSH_APPLICATIONS_PATHS

private static final String
PUSH_APPLICATIONS_PATHS_KEY

Synthetic registry key: command paths are persisted under per-application keys (see PUSH_APPLICATIONS_PATHS), not under this key

private static final String
PUSH_CITE_COMMAND

private static final String
PUSH_EMACS_ADDITIONAL_PARAMETERS

private static final String
PUSH_TO_APPLICATION

private static final String
PUSH_VIM_SERVER

private PushToApplicationPreferences
pushToApplicationPreferences

private static final String
RECENT_DATABASES

private RemotePreferences
remotePreferences

public static final String
RESOLVE_STRINGS_FOR_FIELDS

public static final String
SEARCH_CASE_SENSITIVE

public static final String
SEARCH_DISPLAY_MODE

public static final String
SEARCH_FULLTEXT

public static final String
SEARCH_KEEP_GLOBAL_WINDOW_ON_TOP

public static final String
SEARCH_KEEP_SEARCH_STRING

public static final String
SEARCH_REG_EXP

public static final String
SEARCH_USE_POSTGRES

public static final String
SEARCH_WINDOW_DIVIDER_POS

public static final String
SEARCH_WINDOW_HEIGHT

public static final String
SEARCH_WINDOW_WIDTH

private SearchPreferences
searchPreferences

private static final String
SERVER_DIRECT_HTTP_IMPORT

private static final String
SERVER_HTTP_ENABLE

private static final String
SERVER_HTTP_PORT

private static final String
SERVER_LANGUAGE_ENABLE

private static final String
SERVER_LANGUAGE_PORT

private static final String
SERVER_REMOTE_ENABLE

private static final String
SERVER_REMOTE_PORT

private static JabRefCliPreferences
singleton

private static final String
SSL_TRUSTSTORE_PATH

private SSLPreferences
sslPreferences

public static final Character
STRINGLIST_DELIMITER

public static final String
TIMESTAMP_ADD_CREATION_DATE

public static final String
TIMESTAMP_ADD_MODIFICATION_DATE

public static final String
TIMESTAMP_DEPRECATED_FIELD

public static final String
TIMESTAMP_DEPRECATED_FORMAT

public static final String
TIMESTAMP_DEPRECATED_UPDATE

private TimestampPreferences
timestampPreferences

private static final String
USE_AMS_FJOURNAL

public static final String
VERSION_CHECK_ENABLED

public static final String
VERSION_IGNORED_UPDATE

public static final String
XMP_PRIVACY_FILTERS

public static final String
XMP_USE_PRIVACY_FILTER

private XmpPreferences
xmpPreferences

Constructor Summary

AccessConstructor and Description
public
JabRefCliPreferences()

Method Summary

Modifier and TypeMethod and Description
private void
addEntryTypesFromPreferences(Preferences prefsNode, Map<String, BibEntryType> storedEntryTypes, boolean allowOverWrite, String versionLabel)

protected void
bindBoolean(BooleanProperty property, String key, boolean defaultValue)

protected void
bindBooleanInverted(BooleanProperty property, String key, boolean defaultValue)

Binds a boolean persisted inverted: the backing store holds !property.

protected <T> void
bindCustom(Property<T> property, String key, T defaultValue, ChangeListener<? super T>
writes value changes to the backing store
persistListener, Runnable
loads the stored value (or the default) into the property
importFromStore, Runnable
restores the property to its default value
resetToDefaults)

General binding primitive that all scalar bind* helpers delegate to.

protected <T> void
bindCustomList(ObservableList<T> list, String
the binding's reporting key in getPreferences() and getDefaults()
key, List<T>
restored on reset and reported as the default
defaultList, Consumer<? super ObservableList<T>>
rewrites the whole list to the backing store; receives the bound list, runs on every change
persist, Supplier<? extends Collection<? extends T>>
reads the stored list, falling back to defaultList for absent entries
loadFromStore)

Binds an observable list with caller-supplied persistence; the general primitive behind the other bindCustomList.

private <T> void
bindCustomList(ObservableList<T> list, String key, List<T> defaultList, Function<List<T>, String>
converts the list to its stored String form
serializer, Function<String, ? extends Collection<T>>
reconstructs the list elements from their stored String form
deserializer)

Binds an observable list persisted as a single String.

protected void
bindDouble(DoubleProperty property, String key, double defaultValue)

protected final <T> void
bindExclusiveFlags(ObjectProperty<T> property, T
reported as the default, restored on reset, and returned on load when no flag was ever stored
defaultValue, T
the value owning no key, encoded as all flags false
implicitValue, Map.Entry<String, T>...
the backing-store key for each non-implicit value, in load lookup order (first match wins)
flags)

Binds an enum-valued property persisted as a set of mutually exclusive boolean keys, one per flag.

protected void
bindInt(IntegerProperty property, String key, int defaultValue)

protected <K, V> void
bindMap(ObservableMap<K, V> map, String key, Map<K, V> defaultMap, MapChangeListener<? super K, ? super V>
persists individual entry changes to the backing store
serializer, Function<Map<K, V>, Map<K, V>>
reads the stored map, falling back to defaultMap for missing entries
deserializer)

Binds a map-valued property.

protected <T> void
bindObject(ObjectProperty<T> property, String key, T defaultValue, Function<T, String>
converts a value to its stored String form
serializer, Function<String, T>
reconstructs a value from its stored String form
deserializer)

Binds an object-valued property persisted as a String.

private void
bindPath(ObjectProperty<@Nullable Path> property, String key, @Nullable Path defaultValue)

Binds a path-valued property persisted as a String (null as "").

protected void
bindPathList(ObservableList<Path> list, String
the binding's reporting key in getPreferences() and getDefaults()
key, List<Path>
restored on reset and reported as the default
defaultList)

Binds an observable list of paths persisted as a single delimited String (each path via Path#toString, read back via Path#of).

protected <T> void
bindSet(ObservableSet<T> set, String
the binding's reporting key in getPreferences() and getDefaults()
key, Set<T>
restored on reset and reported as the default
defaultSet, Consumer<? super ObservableSet<T>>
rewrites the whole set to the backing store; receives the bound set, runs on every change
serializer, Supplier<? extends Collection<? extends T>>
reads the stored set, falling back to defaultSet for absent entries
deserializer)

Binds an observable set; the set counterpart of the primitive bindCustomList.

protected void
bindString(StringProperty property, String key, String defaultValue)

private void
bindToKeyring(StringProperty property, JabRefCliPreferences.KeyringSlot
the keyring location to write to
slot, BooleanSupplier
gate evaluated on every change; the value is written only while it returns true
shouldPersist)

Persist-only binding for secrets kept in the system keyring rather than the backing store.

public void
clear()

Implements org.jabref.logic.preferences.CliPreferences.clear.

Clear all preferences.

private void
clearAllBibEntryTypes()

private void
clearBibEntryTypes(BibDatabaseMode mode)

private void
clearCitationKeyPatterns()

private void
clearCustomFetcherKeys()

private void
clearTruststoreFromCustomCertificates()

pack-priv static String
convertListToString(List<String> value)

pack-priv static List<String>
convertStringToList(String toConvert)

public void
deleteKey(String key)

Implements org.jabref.logic.preferences.CliPreferences.deleteKey.

Removes the given key from the preferences.

public void
exportPreferences(Path
Path to export to
path)

Implements org.jabref.logic.preferences.CliPreferences.exportPreferences.

Exports Preferences to an XML file.

public void
flush()

Implements org.jabref.logic.preferences.CliPreferences.flush.

Calling this method will write all preferences into the preference store.

public String
get(String key, String def)

public AbbreviationPreferences
getAbbreviationPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getAbbreviationPreferences.

public AiPreferences
getAiPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getAiPreferences.

public AutoLinkPreferences
getAutoLinkPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getAutoLinkPreferences.

public BibEntryPreferences
getBibEntryPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getBibEntryPreferences.

private List<BibEntryType>
getBibEntryTypes(BibDatabaseMode bibDatabaseMode)

public boolean
getBoolean(String key, boolean def)

private BstCitationFormat
getBstCitationFormatFromPrefs(BstCitationFormat defaultFormat)

public CitationKeyPatternPreferences
getCitationKeyPatternPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getCitationKeyPatternPreferences.

private CitationType
getCitationTypeFromPrefs(CitationType defaultType)

private Set<CleanupPreferences.CleanupStep>
getCleanupActiveJobs(Set<CleanupPreferences.CleanupStep> defaults)

private FieldFormatterCleanupActions
getCleanupFieldFormatters(FieldFormatterCleanupActions defaults)

public CleanupPreferences
getCleanupPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getCleanupPreferences.

private OOStyle
getCurrentOOStyle(OOStyle defaultStyle, JournalAbbreviationRepository journalAbbreviationRepository)

Reconstructs the persisted OOStyle from its stored path: a CSL style file becomes a org.jabref.logic.citationstyle.CitationStyle, otherwise Handles CSL (.csl), BST (.bst), and JStyle (.jstyle) files.

public BibEntryTypesManager
getCustomEntryTypesRepository()

Implements org.jabref.logic.preferences.CliPreferences.getCustomEntryTypesRepository.

private List<TemplateExporter>
getCustomExportFormats(List<TemplateExporter> defaults)

private Set<CustomImporter>
getCustomImportFormats(Set<CustomImporter> defaults)

protected Path
getDefaultPath()

private PlainCitationParserChoice
getDefaultPlainCitationParser(PlainCitationParserChoice defaultPlainCitationParser)

public Map<String, Object>
getDefaults()

Implements org.jabref.logic.preferences.CliPreferences.getDefaults.

public DOIPreferences
getDOIPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getDOIPreferences.

public double
getDouble(String key, double def)

public ExportPreferences
getExportPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getExportPreferences.

protected SaveOrder
getExportSaveOrder(SaveOrder defaults)

private Set<FetcherApiKey>
getFetcherKeys(Set<FetcherApiKey> defaults)

private List<String>
getFetcherKeysFromKeyring(List<String> names)

Reads the stored API keys aligned to names order ("" where a key is absent), or an empty list if the keyring is unavailable, so the caller falls back to default keys on a size mismatch.

public FieldPreferences
getFieldPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getFieldPreferences.

public SequencedSet<Field>
getFieldSequencedSet(String key, ObservableSet<Field> def)

Returns a Sequenced Set of Fields.

public FilePreferences
getFilePreferences()

Implements org.jabref.logic.preferences.CliPreferences.getFilePreferences.

public GitPreferences
getGitPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getGitPreferences.

private @NonNull GlobalCitationKeyPatterns
getGlobalCitationKeyPattern(CitationKeyPatternPreferences defaults)

public GrobidPreferences
getGrobidPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getGrobidPreferences.

public ImporterPreferences
getImporterPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getImporterPreferences.

public static JabRefCliPreferences
getInstance()
Deprecated Never ever add a call to this method.

public int
getInt(String key, int def)

public InternalPreferences
getInternalPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getInternalPreferences.

protected Language
getLanguage()

public LastFilesOpenedPreferences
getLastFilesOpenedPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getLastFilesOpenedPreferences.

public LibraryPreferences
getLibraryPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getLibraryPreferences.

public NameFormatterPreferences
getNameFormatterPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getNameFormatterPreferences.

private Object
getObject(Observable observable)

public OcrPreferences
getOcrPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getOcrPreferences.

public OpenOfficePreferences
getOpenOfficePreferences(JournalAbbreviationRepository journalAbbreviationRepository)

Implements org.jabref.logic.preferences.CliPreferences.getOpenOfficePreferences.

public OwnerPreferences
getOwnerPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getOwnerPreferences.

private Path
getPath(String key, Path defaultValue)

Returns a Path

public Map<String, Object>
getPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getPreferences.

private static Preferences
getPrefsNodeForCustomizedEntryTypes(BibDatabaseMode mode)

private static Preferences
getPrefsNodeForCustomizedEntryTypesV2(BibDatabaseMode mode)

public ProtectedTermsPreferences
getProtectedTermsPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getProtectedTermsPreferences.

public ProxyPreferences
getProxyPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getProxyPreferences.

public PushToApplicationPreferences
getPushToApplicationPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getPushToApplicationPreferences.

public RemotePreferences
getRemotePreferences()

Implements org.jabref.logic.preferences.CliPreferences.getRemotePreferences.

private Set<SearchFlags>
getSearchFlags(SearchPreferences defaults)

public SearchPreferences
getSearchPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getSearchPreferences.

public SelfContainedSaveConfiguration
getSelfContainedExportConfiguration()

Implements org.jabref.logic.preferences.CliPreferences.getSelfContainedExportConfiguration.

Returns the export configuration.

protected List<String>
getSeries(String key)

Returns a list of Strings stored by key+N with N being an incrementing number

public SSLPreferences
getSSLPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getSSLPreferences.

public List<String>
getStringList(String key)

Returns a List of Strings containing the chosen columns.

public TimestampPreferences
getTimestampPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getTimestampPreferences.

public XmpPreferences
getXmpPreferences()

Implements org.jabref.logic.preferences.CliPreferences.getXmpPreferences.

private Set<Field>
getXmpPrivacyFilter(Set<Field> defaults)

public boolean

Returns:

true if the key is set, false otherwise.
hasKey(String
The key to check.
key)

Check whether a key is set (differently from null).

public void
importPreferences(Path
Path of file to import from
path)

Implements org.jabref.logic.preferences.CliPreferences.importPreferences.

Imports Preferences from an XML file.

private static void
importPreferencesToBackingStore(Path path)

protected void
initializeAll()

Instantiates every preference group so its bindings are registered in allBindings before a bulk reset/import runs.

private void
migrateEmbeddingModelName(AiPreferences defaultValues)

private void
migrateLegacyAiResponseEngineKind(AiPreferences defaultValues)

protected boolean
moveToTrashSupported()

protected void
purgeSeries(String prefix, int
or higher.
number)

Removes all entries keyed by prefix+number, where number is equal to or higher than the given number.

public void
put(String key, String value)

public void
putBoolean(String key, boolean value)

public void
putDouble(String key, double value)

public void
putInt(String key, int value)

public void
putInt(String key, Number value)

public void
putStringList(String key, List<String> value)

Puts a list of strings into the Preferences, by linking its elements with a STRINGLIST_DELIMITER into a single string.

protected final <T> T

Returns:

the stored enum value, or defaultValue/implicitValue per the rules above
readExclusiveFlags(T
returned when none of the flag keys exist
defaultValue, T
returned when all flag keys are stored false
implicitValue, Map.Entry<String, T>...
the backing-store key for each non-implicit value, in lookup order (first match wins)
flags)

Reads an enum persisted as mutually exclusive boolean keys (see bindExclusiveFlags).

private Optional<String>
readKeyring(JabRefCliPreferences.KeyringSlot slot)

Reads the secret at a single slot, or empty if it is absent/blank or the keyring is unavailable.

private Map<JabRefCliPreferences.KeyringSlot, String>
readKeyring(List<JabRefCliPreferences.KeyringSlot> slots)

Reads and decrypts the secrets at the given slots in a single keyring session.

private Map<String, String>
readPushToApplicationPath(Map<String, String> defaults)

An empty string is used as the default value to ensure that an installation of a tool leads to the new path (instead of leaving the empty one).

protected void
remove(String key)

private void
storeBibEntryTypes(Collection<BibEntryType> bibEntryTypes, BibDatabaseMode bibDatabaseMode)

public void
storeCustomEntryTypesRepository(BibEntryTypesManager entryTypesManager)

Implements org.jabref.logic.preferences.CliPreferences.storeCustomEntryTypesRepository.

private void
storeCustomExportFormats(List<TemplateExporter> exporters)

private void
storeCustomImportFormats(Set<CustomImporter> importers)

private void
storeExportSaveOrder(SaveOrder saveOrder)

private void
storeFetcherKeys(ImporterPreferences defaults)

public void
storeGlobalCitationKeyPattern(GlobalCitationKeyPatterns pattern)

private void
storePushToApplicationPath(MapChangeListener.Change<? extends String, ? extends String> change)

private void
writeKeyring(JabRefCliPreferences.KeyringSlot slot, String secret)

Writes (or, for a blank secret, clears) a single slot.

private void
writeKeyring(Map<JabRefCliPreferences.KeyringSlot, String> secrets)

Encrypts and writes each secret to its slot in a single keyring session.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait