Modifier and Type	Class and Description
public static enum	BibDatabaseWriter.SaveType

Modifier and Type	Field and Description
protected final BibWriter	bibWriter
private static final String	COMMENT_PREFIX
public static final String	DATABASE_ID_PREFIX
protected final BibEntryTypesManager	entryTypesManager
protected final FieldPreferences	fieldPreferences
private @Nullable JournalAbbreviationRepository	journalAbbreviationRepository
protected final CitationKeyPatternPreferences	keyPatternPreferences
private static final Logger	LOGGER
private Consumer<Runnable>	mutationScheduler
private static final String	PREAMBLE_PREFIX
private static final Pattern	REFERENCE_PATTERN
protected final List<FieldChange>	saveActionsFieldChanges
protected final SelfContainedSaveConfiguration	saveConfiguration
private static final String	STRING_PREFIX
private boolean	useFJournalField

Access	Constructor and Description
public	BibDatabaseWriter(@NonNull BibWriter bibWriter, SelfContainedSaveConfiguration saveConfiguration, FieldPreferences fieldPreferences, CitationKeyPatternPreferences keyPatternPreferences, BibEntryTypesManager entryTypesManager)
public	BibDatabaseWriter(@NonNull Writer the output to use writer, @NonNull BibDatabaseContext - used to get the newline bibDatabaseContext, @NonNull CliPreferences - used to read all the preferences preferences) Convenience constructor.

Method Summary

Modifier and Type	Method and Description
private static List<FieldChange>	applySaveActions(List<BibEntry> toChange, MetaData metaData, FieldPreferences fieldPreferences, Consumer<Runnable> mutationScheduler)
public static List<FieldChange>	applySaveActions(BibEntry entry, MetaData metaData, FieldPreferences fieldPreferences)
protected List<FieldChange>	generateCitationKeys(BibDatabaseContext databaseContext, List<BibEntry> entries, Consumer<Runnable> mutationScheduler) Generate keys for all entries that are lacking keys.
public List<FieldChange>	getSaveActionsFieldChanges()
private static List<Comparator<BibEntry>>	getSaveComparators(SaveOrder saveOrder)
public static List<BibEntry>	getSortedEntries(@NonNull List<BibEntry> entriesToSort, @NonNull SelfContainedSaveOrder saveOrder) We have begun to use getSortedEntries() for both database save operations and non-database save operations.
public BibDatabaseWriter	withJournalAbbreviationRepository(@NonNull JournalAbbreviationRepository repository, boolean useFJournalField)
public BibDatabaseWriter	withMutationScheduler(Consumer<Runnable> mutationScheduler) Routes `BibEntry` field mutations performed while saving to the correct thread.
public void	writeDatabase(@NonNull BibDatabaseContext bibDatabaseContext) Saves the complete database.
protected void	writeDatabaseID(String sharedDatabaseID)
protected void	writeEntry(BibEntry entry, BibDatabaseMode mode)
protected void	writeEntryTypeDefinition(BibEntryType customType)
protected void	writeEntryTypeDefinitions(SortedSet<BibEntryType> types)
protected void	writeEpilogue(String epilogue)
protected void	writeMetaData(@NonNull MetaData metaData, GlobalCitationKeyPatterns globalCiteKeyPattern) Writes all data to the specified writer, using each object's toString() method.
protected void	writeMetaDataItem(Map.Entry<String, String> metaItem)
public void	writePartOfDatabase(BibDatabaseContext bibDatabaseContext, List<BibEntry> A list of entries to save. The list itself is not modified in this code entries) Saves the database, including only the specified entries.
protected void	writePreamble(String preamble)
protected void	writeProlog(BibDatabaseContext bibDatabaseContext, Charset encoding)
protected void	writeString(BibtexString bibtexString, Map<String, BibtexString> remaining, int maxKeyLength)
protected void	writeString(BibtexString bibtexString, int maxKeyLength)
private void	writeStrings(BibDatabase The database whose strings we should write. database) Write all strings in alphabetical order, modified to produce a safe (for BibTeX) order of the strings if they reference each other.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bibWriter	back to summary
protected final BibWriter bibWriter

COMMENT_PREFIX	back to summary
private static final String COMMENT_PREFIX

DATABASE_ID_PREFIX	back to summary
public static final String DATABASE_ID_PREFIX

entryTypesManager	back to summary
protected final BibEntryTypesManager entryTypesManager

fieldPreferences	back to summary
protected final FieldPreferences fieldPreferences

journalAbbreviationRepository	back to summary
private @Nullable JournalAbbreviationRepository journalAbbreviationRepository

keyPatternPreferences	back to summary
protected final CitationKeyPatternPreferences keyPatternPreferences

LOGGER	back to summary
private static final Logger LOGGER

mutationScheduler	back to summary
private Consumer<Runnable> mutationScheduler

PREAMBLE_PREFIX	back to summary
private static final String PREAMBLE_PREFIX

REFERENCE_PATTERN	back to summary
private static final Pattern REFERENCE_PATTERN

saveActionsFieldChanges	back to summary
protected final List<FieldChange> saveActionsFieldChanges

saveConfiguration	back to summary
protected final SelfContainedSaveConfiguration saveConfiguration

STRING_PREFIX	back to summary
private static final String STRING_PREFIX

useFJournalField	back to summary
private boolean useFJournalField

Constructor Detail

BibDatabaseWriter	back to summary
public BibDatabaseWriter(@NonNull BibWriter bibWriter, SelfContainedSaveConfiguration saveConfiguration, FieldPreferences fieldPreferences, CitationKeyPatternPreferences keyPatternPreferences, BibEntryTypesManager entryTypesManager)

BibDatabaseWriter back to summary

BibDatabaseWriter	back to summary
public BibDatabaseWriter(@NonNull Writer writer, @NonNull BibDatabaseContext bibDatabaseContext, @NonNull CliPreferences preferences) Convenience constructor. One can directly call `writeDatabase(BibDatabaseContext)` afterward. Parameters writer:@NonNull Writer the output to use bibDatabaseContext:@NonNull BibDatabaseContext - used to get the newline preferences:@NonNull CliPreferences - used to read all the preferences

public BibDatabaseWriter(@NonNull Writer writer, @NonNull BibDatabaseContext bibDatabaseContext, @NonNull CliPreferences preferences)

Convenience constructor. One can directly call writeDatabase(BibDatabaseContext) afterward.

Parameters

writer:@NonNull Writer: the output to use
bibDatabaseContext:@NonNull BibDatabaseContext: - used to get the newline
preferences:@NonNull CliPreferences: - used to read all the preferences

Method Detail

applySaveActions	back to summary
private static List<FieldChange> applySaveActions(List<BibEntry> toChange, MetaData metaData, FieldPreferences fieldPreferences, Consumer<Runnable> mutationScheduler)

applySaveActions	back to summary
public static List<FieldChange> applySaveActions(BibEntry entry, MetaData metaData, FieldPreferences fieldPreferences)

generateCitationKeys	back to summary
protected List<FieldChange> generateCitationKeys(BibDatabaseContext databaseContext, List<BibEntry> entries, Consumer<Runnable> mutationScheduler) Generate keys for all entries that are lacking keys.

getSaveActionsFieldChanges	back to summary
public List<FieldChange> getSaveActionsFieldChanges()

getSaveComparators	back to summary
private static List<Comparator<BibEntry>> getSaveComparators(SaveOrder saveOrder)

getSortedEntries	back to summary
public static List<BibEntry> getSortedEntries(@NonNull List<BibEntry> entriesToSort, @NonNull SelfContainedSaveOrder saveOrder) We have begun to use getSortedEntries() for both database save operations and non-database save operations. In a non-database save operation (such as the exportDatabase call), we do not wish to use the global preference of saving in standard order.

withJournalAbbreviationRepository	back to summary
public BibDatabaseWriter withJournalAbbreviationRepository(@NonNull JournalAbbreviationRepository repository, boolean useFJournalField)

withMutationScheduler	back to summary
public BibDatabaseWriter withMutationScheduler(Consumer<Runnable> mutationScheduler) Routes `BibEntry` field mutations performed while saving to the correct thread. The scheduler must execute each mutation synchronously so the written file contains it.

writeDatabase	back to summary
public void writeDatabase(@NonNull BibDatabaseContext bibDatabaseContext) throws IOException Saves the complete database.

writeDatabaseID	back to summary
protected void writeDatabaseID(String sharedDatabaseID) throws IOException

writeEntry	back to summary
protected void writeEntry(BibEntry entry, BibDatabaseMode mode) throws IOException

writeEntryTypeDefinition	back to summary
protected void writeEntryTypeDefinition(BibEntryType customType) throws IOException

writeEntryTypeDefinitions	back to summary
protected void writeEntryTypeDefinitions(SortedSet<BibEntryType> types) throws IOException

writeEpilogue	back to summary
protected void writeEpilogue(String epilogue) throws IOException

writeMetaData	back to summary
protected void writeMetaData(@NonNull MetaData metaData, GlobalCitationKeyPatterns globalCiteKeyPattern) throws IOException Writes all data to the specified writer, using each object's toString() method.

writeMetaDataItem	back to summary
protected void writeMetaDataItem(Map.Entry<String, String> metaItem) throws IOException

writePartOfDatabase	back to summary
public void writePartOfDatabase(BibDatabaseContext bibDatabaseContext, List<BibEntry> entries) throws IOException Saves the database, including only the specified entries. Parameters entries:List<BibEntry> A list of entries to save. The list itself is not modified in this code

writePartOfDatabase

back to summary

public void writePartOfDatabase(BibDatabaseContext bibDatabaseContext, List<BibEntry> entries) throws IOException

Saves the database, including only the specified entries.

Parameters

entries:List<BibEntry>: A list of entries to save. The list itself is not modified in this code

writePreamble	back to summary
protected void writePreamble(String preamble) throws IOException

writeProlog	back to summary
protected void writeProlog(BibDatabaseContext bibDatabaseContext, Charset encoding) throws IOException

writeString	back to summary
protected void writeString(BibtexString bibtexString, Map<String, BibtexString> remaining, int maxKeyLength) throws IOException

writeString	back to summary
protected void writeString(BibtexString bibtexString, int maxKeyLength) throws IOException

writeStrings	back to summary
private void writeStrings(BibDatabase database) throws IOException Write all strings in alphabetical order, modified to produce a safe (for BibTeX) order of the strings if they reference each other. Parameters database:BibDatabase The database whose strings we should write.

writeStrings

back to summary

private void writeStrings(BibDatabase database) throws IOException

Write all strings in alphabetical order, modified to produce a safe (for BibTeX) order of the strings if they reference each other.

Parameters

database:BibDatabase: The database whose strings we should write.

org.jabref.logic.exporter back to summary

public final Enum BibDatabaseWriter.SaveType

Class Inheritance

extends Enum<BibDatabaseWriter.SaveType>

java.lang.Object
java.lang.Enum
org.jabref.logic.exporter.BibDatabaseWriter.SaveType

Field Summary

Modifier and Type	Field and Description
public static final BibDatabaseWriter.SaveType	PLAIN_BIBTEX
public static final BibDatabaseWriter.SaveType	WITH_JABREF_META_DATA

Constructor Summary

Access	Constructor and Description
private	SaveType()

Method Summary

Modifier and Type	Method and Description
public static BibDatabaseWriter.SaveType	valueOf(String name)
public static BibDatabaseWriter.SaveType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

PLAIN_BIBTEX	back to summary
public static final BibDatabaseWriter.SaveType PLAIN_BIBTEX

WITH_JABREF_META_DATA	back to summary
public static final BibDatabaseWriter.SaveType WITH_JABREF_META_DATA

Constructor Detail

SaveType	back to summary
private SaveType()

Method Detail

valueOf	back to summary
public static BibDatabaseWriter.SaveType valueOf(String name)

values	back to summary
public static BibDatabaseWriter.SaveType[] values()

public Class BibDatabaseWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum BibDatabaseWriter.SaveType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail