JabRef 6.0-beta.1 · org.jabref.logic.citationstyle.CSLStyleLoader

Field Summary

Modifier and Type	Field and Description
private static final List<String>	CATALOG_KEYS Keys written by `CitationStyleCatalogGenerator#generateCatalog`.
private static final String	CATALOG_PATH
public static final String	DEFAULT_STYLE
private static final CitationStyle	EMPTY_STYLE Placeholder returned when even the default style cannot be loaded.
private static final List<CitationStyle>	EXTERNAL_STYLES
private static final List<CitationStyle>	INTERNAL_STYLES
private static final Logger	LOGGER
private final OpenOfficePreferences	openOfficePreferences Record Component accessed by openOfficePreferences().
private static final String	STYLES_ROOT

Constructor Summary

Access	Constructor and Description
public	CSLStyleLoader(@NonNull OpenOfficePreferences openOfficePreferences)

Method Summary

Modifier and Type	Method and Description
public void	addExternalStyle(@NonNull CitationStyle citationStyle) Adds a new external CSL style.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
pack-priv static List<String>	findMissingCatalogKeys(Map<String, Object> info)
public static CitationStyle	getDefaultStyle() Returns the default citation style which is currently set to `CSLStyleLoader#DEFAULT_STYLE`.
public static List<CitationStyle>	getInternalStyles()
public static List<CitationStyle>	getStyles() Returns a list of all available citation styles (both internal and external).
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
private void	loadExternalStyles() Loads external CSL styles from the preferences.
public static void	loadInternalStyles() Loads the internal (built-in) CSL styles from the catalog generated at build-time.
private static String	loadInternalStyleSource(String path)
public OpenOfficePreferences	openOfficePreferences() Record Component getter of openOfficePreferences.
public boolean	Returns: true if the style was removed, false otherwise removeStyle(@NonNull CitationStyle style) Removes a style from the external styles list.
private void	storeExternalStyles() Stores the current list of external styles to preferences.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

CATALOG_KEYS	back to summary
private static final List<String> CATALOG_KEYS Keys written by `CitationStyleCatalogGenerator#generateCatalog`. Keep in sync when adding style metadata.

CATALOG_PATH	back to summary
private static final String CATALOG_PATH

DEFAULT_STYLE	back to summary
public static final String DEFAULT_STYLE

EMPTY_STYLE	back to summary
private static final CitationStyle EMPTY_STYLE Placeholder returned when even the default style cannot be loaded. Not backed by a CSL source.

EXTERNAL_STYLES	back to summary
private static final List<CitationStyle> EXTERNAL_STYLES

INTERNAL_STYLES	back to summary
private static final List<CitationStyle> INTERNAL_STYLES

LOGGER	back to summary
private static final Logger LOGGER

openOfficePreferences	back to summary
private final OpenOfficePreferences openOfficePreferences Record Component accessed by openOfficePreferences().

STYLES_ROOT	back to summary
private static final String STYLES_ROOT

Constructor Detail

CSLStyleLoader	back to summary
public CSLStyleLoader(@NonNull OpenOfficePreferences openOfficePreferences)

Method Detail

addExternalStyle	back to summary
public void addExternalStyle(@NonNull CitationStyle citationStyle) Adds a new external CSL style.

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

findMissingCatalogKeys	back to summary
pack-priv static List<String> findMissingCatalogKeys(Map<String, Object> info)

getDefaultStyle	back to summary
public static CitationStyle getDefaultStyle() Returns the default citation style which is currently set to `CSLStyleLoader#DEFAULT_STYLE`.

getInternalStyles	back to summary
public static List<CitationStyle> getInternalStyles()

getStyles	back to summary
public static List<CitationStyle> getStyles() Returns a list of all available citation styles (both internal and external).

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.

loadExternalStyles	back to summary
private void loadExternalStyles() Loads external CSL styles from the preferences.

loadInternalStyles	back to summary
public static void loadInternalStyles() Loads the internal (built-in) CSL styles from the catalog generated at build-time.

loadInternalStyleSource	back to summary
private static String loadInternalStyleSource(String path)

openOfficePreferences	back to summary
public OpenOfficePreferences openOfficePreferences() Record Component getter of openOfficePreferences.

removeStyle	back to summary
public boolean removeStyle(@NonNull CitationStyle style) Removes a style from the external styles list. Returns:boolean true if the style was removed, false otherwise

removeStyle

back to summary

public boolean removeStyle(@NonNull CitationStyle style)

Removes a style from the external styles list.

Returns:boolean: true if the style was removed, false otherwise

storeExternalStyles	back to summary
private void storeExternalStyles() Stores the current list of external styles to preferences.

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.