Verified Owner
Top Inners Fields Constructors Methods
org.jabref.logic.cleanup

public Class CleanupPreferences

extends Object
Class Inheritance
Imports
java.util.EnumSet, .HashSet, .Optional, .Set, javafx.beans.property.ObjectProperty, .SimpleObjectProperty, javafx.collections.FXCollections, .ObservableSet

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CleanupPreferences.CleanupStep

Field Summary

Modifier and TypeField and Description
private final ObservableSet<CleanupPreferences.CleanupStep>
activeJobs

private static final EnumSet<CleanupPreferences.CleanupStep>
DEFAULT_ACTIVE_JOBS

private static final FieldFormatterCleanupActions
DEFAULT_FIELD_FORMATTER_CLEANUPS

private final ObjectProperty<FieldFormatterCleanupActions>
fieldFormatterCleanups

Constructor Summary

AccessConstructor and Description
private
CleanupPreferences()

public
CleanupPreferences(Set<CleanupPreferences.CleanupStep> activeJobs)

public
CleanupPreferences(CleanupPreferences.CleanupStep activeJob)

public
CleanupPreferences(FieldFormatterCleanupActions formatterCleanups)

public
CleanupPreferences(Set<CleanupPreferences.CleanupStep> activeJobs, FieldFormatterCleanupActions formatterCleanups)

Method Summary

Modifier and TypeMethod and Description
public ObjectProperty<FieldFormatterCleanupActions>
fieldFormatterCleanupsProperty()

public Set<CleanupPreferences.CleanupStep>
getActiveJobs()

public static CleanupPreferences
getDefault()

public FieldFormatterCleanupActions
getFieldFormatterCleanups()

public ObservableSet<CleanupPreferences.CleanupStep>
getObservableActiveJobs()

public Boolean
isActive(CleanupPreferences.CleanupStep step)

public void
setActiveJobs(Set<CleanupPreferences.CleanupStep> jobs)

public void
setFieldFormatterCleanups(FieldFormatterCleanupActions fieldFormatters)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

activeJobsback to summary
private final ObservableSet<CleanupPreferences.CleanupStep> activeJobs
DEFAULT_ACTIVE_JOBSback to summary
private static final EnumSet<CleanupPreferences.CleanupStep> DEFAULT_ACTIVE_JOBS
DEFAULT_FIELD_FORMATTER_CLEANUPSback to summary
private static final FieldFormatterCleanupActions DEFAULT_FIELD_FORMATTER_CLEANUPS
fieldFormatterCleanupsback to summary
private final ObjectProperty<FieldFormatterCleanupActions> fieldFormatterCleanups

Constructor Detail

CleanupPreferencesback to summary
private CleanupPreferences()
CleanupPreferencesback to summary
public CleanupPreferences(Set<CleanupPreferences.CleanupStep> activeJobs)
CleanupPreferencesback to summary
public CleanupPreferences(CleanupPreferences.CleanupStep activeJob)
CleanupPreferencesback to summary
public CleanupPreferences(FieldFormatterCleanupActions formatterCleanups)
CleanupPreferencesback to summary
public CleanupPreferences(Set<CleanupPreferences.CleanupStep> activeJobs, FieldFormatterCleanupActions formatterCleanups)

Method Detail

fieldFormatterCleanupsPropertyback to summary
public ObjectProperty<FieldFormatterCleanupActions> fieldFormatterCleanupsProperty()
getActiveJobsback to summary
public Set<CleanupPreferences.CleanupStep> getActiveJobs()
getDefaultback to summary
public static CleanupPreferences getDefault()
getFieldFormatterCleanupsback to summary
public FieldFormatterCleanupActions getFieldFormatterCleanups()
getObservableActiveJobsback to summary
public ObservableSet<CleanupPreferences.CleanupStep> getObservableActiveJobs()
isActiveback to summary
public Boolean isActive(CleanupPreferences.CleanupStep step)
setActiveJobsback to summary
public void setActiveJobs(Set<CleanupPreferences.CleanupStep> jobs)
setFieldFormatterCleanupsback to summary
public void setFieldFormatterCleanups(FieldFormatterCleanupActions fieldFormatters)
org.jabref.logic.cleanup back to summary

public final Enum CleanupPreferences.CleanupStep

extends Enum<CleanupPreferences.CleanupStep>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final CleanupPreferences.CleanupStep
ABBREVIATE_DEFAULT

public static final CleanupPreferences.CleanupStep
ABBREVIATE_DOTLESS

public static final CleanupPreferences.CleanupStep
ABBREVIATE_LTWA

public static final CleanupPreferences.CleanupStep
ABBREVIATE_SHORTEST_UNIQUE

public static final CleanupPreferences.CleanupStep
CLEAN_UP_ARXIV_DOI

public static final CleanupPreferences.CleanupStep
CLEAN_UP_DELETED_LINKED_FILES

public static final CleanupPreferences.CleanupStep
CLEAN_UP_DOI

public static final CleanupPreferences.CleanupStep
CLEAN_UP_UPGRADE_EXTERNAL_LINKS

public static final CleanupPreferences.CleanupStep
CLEAN_UP_URL

public static final CleanupPreferences.CleanupStep
CLEANUP_EPRINT

public static final CleanupPreferences.CleanupStep
CONVERT_MSC_CODES

public static final CleanupPreferences.CleanupStep
CONVERT_TIMESTAMP_TO_CREATIONDATE

public static final CleanupPreferences.CleanupStep
CONVERT_TIMESTAMP_TO_MODIFICATIONDATE

public static final CleanupPreferences.CleanupStep
CONVERT_TO_BIBLATEX

public static final CleanupPreferences.CleanupStep
CONVERT_TO_BIBTEX

public static final CleanupPreferences.CleanupStep
DO_NOT_CONVERT_TIMESTAMP

public static final CleanupPreferences.CleanupStep
FIX_FILE_LINKS

public static final CleanupPreferences.CleanupStep
MAKE_PATHS_RELATIVE

public static final CleanupPreferences.CleanupStep
MOVE_PDF

public static final CleanupPreferences.CleanupStep
REMOVE_XMP_METADATA

public static final CleanupPreferences.CleanupStep
RENAME_PDF

public static final CleanupPreferences.CleanupStep
RENAME_PDF_ONLY_RELATIVE_PATHS

public static final CleanupPreferences.CleanupStep
UNABBREVIATE

Constructor Summary

AccessConstructor and Description
private
CleanupStep()

Method Summary

Modifier and TypeMethod and Description
public static Optional<CleanupPreferences.CleanupStep>
safeValueOf(String name)

Parses a step name, returning an empty Optional for unknown or removed values.

public static CleanupPreferences.CleanupStep
valueOf(String name)

public static CleanupPreferences.CleanupStep[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ABBREVIATE_DEFAULTback to summary
public static final CleanupPreferences.CleanupStep ABBREVIATE_DEFAULT
ABBREVIATE_DOTLESSback to summary
public static final CleanupPreferences.CleanupStep ABBREVIATE_DOTLESS
ABBREVIATE_LTWAback to summary
public static final CleanupPreferences.CleanupStep ABBREVIATE_LTWA
ABBREVIATE_SHORTEST_UNIQUEback to summary
public static final CleanupPreferences.CleanupStep ABBREVIATE_SHORTEST_UNIQUE
CLEAN_UP_ARXIV_DOIback to summary
public static final CleanupPreferences.CleanupStep CLEAN_UP_ARXIV_DOI
CLEAN_UP_DELETED_LINKED_FILESback to summary
public static final CleanupPreferences.CleanupStep CLEAN_UP_DELETED_LINKED_FILES
CLEAN_UP_DOIback to summary
public static final CleanupPreferences.CleanupStep CLEAN_UP_DOI
CLEAN_UP_URLback to summary
public static final CleanupPreferences.CleanupStep CLEAN_UP_URL
CLEANUP_EPRINTback to summary
public static final CleanupPreferences.CleanupStep CLEANUP_EPRINT
CONVERT_MSC_CODESback to summary
public static final CleanupPreferences.CleanupStep CONVERT_MSC_CODES
CONVERT_TIMESTAMP_TO_CREATIONDATEback to summary
public static final CleanupPreferences.CleanupStep CONVERT_TIMESTAMP_TO_CREATIONDATE
CONVERT_TIMESTAMP_TO_MODIFICATIONDATEback to summary
public static final CleanupPreferences.CleanupStep CONVERT_TIMESTAMP_TO_MODIFICATIONDATE
CONVERT_TO_BIBLATEXback to summary
public static final CleanupPreferences.CleanupStep CONVERT_TO_BIBLATEX
CONVERT_TO_BIBTEXback to summary
public static final CleanupPreferences.CleanupStep CONVERT_TO_BIBTEX
DO_NOT_CONVERT_TIMESTAMPback to summary
public static final CleanupPreferences.CleanupStep DO_NOT_CONVERT_TIMESTAMP
MAKE_PATHS_RELATIVEback to summary
public static final CleanupPreferences.CleanupStep MAKE_PATHS_RELATIVE
MOVE_PDFback to summary
public static final CleanupPreferences.CleanupStep MOVE_PDF
REMOVE_XMP_METADATAback to summary
public static final CleanupPreferences.CleanupStep REMOVE_XMP_METADATA
RENAME_PDFback to summary
public static final CleanupPreferences.CleanupStep RENAME_PDF
RENAME_PDF_ONLY_RELATIVE_PATHSback to summary
public static final CleanupPreferences.CleanupStep RENAME_PDF_ONLY_RELATIVE_PATHS
UNABBREVIATEback to summary
public static final CleanupPreferences.CleanupStep UNABBREVIATE

Constructor Detail

CleanupStepback to summary
private CleanupStep()

Method Detail

safeValueOfback to summary
public static Optional<CleanupPreferences.CleanupStep> safeValueOf(String name)

Parses a step name, returning an empty Optional for unknown or removed values.

Used when loading preferences written by older versions: e.g. the former CLEAN_UP_ISSN step was removed (ISSN normalization now happens via the NormalizeIssn field formatter), and such a stored value must not break preference loading.

valueOfback to summary
public static CleanupPreferences.CleanupStep valueOf(String name)
valuesback to summary
public static CleanupPreferences.CleanupStep[] values()