JabRef 6.0-beta.1 · org.jabref.gui.preview.ClipboardContentGenerator

Modifier and Type	Field and Description
private final JournalAbbreviationRepository	abbreviationRepository Record Component accessed by abbreviationRepository().
private final LayoutFormatterPreferences	layoutFormatterPreferences Record Component accessed by layoutFormatterPreferences().
private final PreviewPreferences	previewPreferences Record Component accessed by previewPreferences().

Access	Constructor and Description
public	ClipboardContentGenerator(PreviewPreferences previewPreferences, LayoutFormatterPreferences layoutFormatterPreferences, JournalAbbreviationRepository abbreviationRepository)

Method Summary

Modifier and Type	Method and Description
public JournalAbbreviationRepository	abbreviationRepository() Record Component getter of abbreviationRepository.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public ClipboardContent	generate(List<BibEntry> selectedEntries, CitationStyleOutputFormat outputFormat, BibDatabaseContext bibDatabaseContext)
private List<String>	generateCitations(List<BibEntry> selectedEntries, CitationStyleOutputFormat outputFormat, BibDatabaseContext bibDatabaseContext)
private List<String>	generateTextBasedPreviewLayoutCitations(List<BibEntry> selectedEntries, BibDatabaseContext bibDatabaseContext)
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public LayoutFormatterPreferences	layoutFormatterPreferences() Record Component getter of layoutFormatterPreferences.
public PreviewPreferences	previewPreferences() Record Component getter of previewPreferences.
pack-priv static ClipboardContent	processHtml(List<String> citations) Inserts each citation into a HTML body and copies it to the clipboard.
pack-priv static ClipboardContent	Returns: clipboard content containing the Markdown representation in its plain string flavor processMarkdown(List<String> the list of already-formatted citation strings to be combined as Markdown citations) Joins each citation using the platform-specific newline into a single Markdown string (from citeproc) and copies it to the clipboard.
pack-priv static ClipboardContent	processPreview(List<String> citations) Generates a plain text string out of the preview (based on `TextBasedPreviewLayout` or `org.jabref.logic.preview.BstPreviewLayout`) and copies it additionally to the html to the clipboard (WYSIWYG Editors use the HTML, plain text editors the text)
pack-priv static ClipboardContent	processText(List<String> citations) Joins every citation with a newline and returns it.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

abbreviationRepository	back to summary
private final JournalAbbreviationRepository abbreviationRepository Record Component accessed by abbreviationRepository().

layoutFormatterPreferences	back to summary
private final LayoutFormatterPreferences layoutFormatterPreferences Record Component accessed by layoutFormatterPreferences().

previewPreferences	back to summary
private final PreviewPreferences previewPreferences Record Component accessed by previewPreferences().

ClipboardContentGenerator	back to summary
public ClipboardContentGenerator(PreviewPreferences previewPreferences, LayoutFormatterPreferences layoutFormatterPreferences, JournalAbbreviationRepository abbreviationRepository)

Method Detail

abbreviationRepository	back to summary
public JournalAbbreviationRepository abbreviationRepository() Record Component getter of abbreviationRepository.

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).

generate	back to summary
public ClipboardContent generate(List<BibEntry> selectedEntries, CitationStyleOutputFormat outputFormat, BibDatabaseContext bibDatabaseContext) throws IOException

generateCitations	back to summary
private List<String> generateCitations(List<BibEntry> selectedEntries, CitationStyleOutputFormat outputFormat, BibDatabaseContext bibDatabaseContext) throws IOException

generateTextBasedPreviewLayoutCitations	back to summary
private List<String> generateTextBasedPreviewLayoutCitations(List<BibEntry> selectedEntries, BibDatabaseContext bibDatabaseContext) throws IOException

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.

layoutFormatterPreferences	back to summary
public LayoutFormatterPreferences layoutFormatterPreferences() Record Component getter of layoutFormatterPreferences.

previewPreferences	back to summary
public PreviewPreferences previewPreferences() Record Component getter of previewPreferences.

processHtml back to summary

processHtml	back to summary
pack-priv static ClipboardContent processHtml(List<String> citations) Inserts each citation into a HTML body and copies it to the clipboard. The given preview is based on `CitationStylePreviewLayout`. Annotations @VisibleForTesting

pack-priv static ClipboardContent processHtml(List<String> citations)

Inserts each citation into a HTML body and copies it to the clipboard. The given preview is based on CitationStylePreviewLayout.

Annotations

@VisibleForTesting

processMarkdown	back to summary
pack-priv static ClipboardContent processMarkdown(List<String> citations) Joins each citation using the platform-specific newline into a single Markdown string (from citeproc) and copies it to the clipboard. A trailing newline is appended if missing to keep the behavior consistent with other output formats and to satisfy tests expecting a newline-terminated string. Parameters citations:List<String> the list of already-formatted citation strings to be combined as Markdown Returns:ClipboardContent clipboard content containing the Markdown representation in its plain string flavor Annotations @VisibleForTesting

processMarkdown

back to summary

pack-priv static ClipboardContent processMarkdown(List<String> citations)

Joins each citation using the platform-specific newline into a single Markdown string (from citeproc) and copies it to the clipboard.

A trailing newline is appended if missing to keep the behavior consistent with other output formats and to satisfy tests expecting a newline-terminated string.

Parameters

citations:List<String>: the list of already-formatted citation strings to be combined as Markdown

Returns:ClipboardContent

clipboard content containing the Markdown representation in its plain string flavor

Annotations

@VisibleForTesting

processPreview back to summary

processPreview	back to summary
pack-priv static ClipboardContent processPreview(List<String> citations) Generates a plain text string out of the preview (based on `TextBasedPreviewLayout` or `org.jabref.logic.preview.BstPreviewLayout`) and copies it additionally to the html to the clipboard (WYSIWYG Editors use the HTML, plain text editors the text) Annotations @VisibleForTesting

pack-priv static ClipboardContent processPreview(List<String> citations)

Generates a plain text string out of the preview (based on TextBasedPreviewLayout or org.jabref.logic.preview.BstPreviewLayout) and copies it additionally to the html to the clipboard (WYSIWYG Editors use the HTML, plain text editors the text)

Annotations

@VisibleForTesting

processText	back to summary
pack-priv static ClipboardContent processText(List<String> citations) Joins every citation with a newline and returns it. Annotations @VisibleForTesting

processText

back to summary

pack-priv static ClipboardContent processText(List<String> citations)

Joins every citation with a newline and returns it.

Annotations

@VisibleForTesting

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.

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 Record ClipboardContentGenerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail