JabRef 6.0-beta.1 · org.jabref.logic.cleanup.FieldFormatterCleanup

Modifier and Type	Field and Description
private final Field	field
private final Formatter	formatter

Access	Constructor and Description
public	FieldFormatterCleanup(Field field, Formatter formatter)

Method Summary

Modifier and Type	Method and Description
public List<FieldChange>	cleanup(BibEntry entry) Implements org.jabref.logic.cleanup.CleanupJob.cleanup. Cleans up the given entry and returns the list of changes made.
public List<FieldChange>	cleanup(BibEntry entry, Consumer<Runnable> mutationScheduler) Overrides default org.jabref.logic.cleanup.CleanupJob.cleanup. Cleans up the given entry, routing all `BibEntry` field mutations through the provided scheduler.
private List<FieldChange>	cleanupAllFields(BibEntry entry, Consumer<Runnable> mutationScheduler)
private List<FieldChange>	cleanupAllTextFields(BibEntry entry, Consumer<Runnable> mutationScheduler)
private List<FieldChange>	Returns: a list of changes of the entry cleanupSingleField(Field the field on which to run the formatter fieldKey, BibEntry the entry to be cleaned up entry, Consumer<Runnable> scheduler for field mutations (e.g. FX thread dispatch) mutationScheduler) Runs the formatter on the specified field in the given entry.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Field	getField()
public Formatter	getFormatter()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

field	back to summary
private final Field field

formatter	back to summary
private final Formatter formatter

FieldFormatterCleanup	back to summary
public FieldFormatterCleanup(Field field, Formatter formatter)

Method Detail

cleanup	back to summary
public List<FieldChange> cleanup(BibEntry entry) Implements org.jabref.logic.cleanup.CleanupJob.cleanup. Doc from org.jabref.logic.cleanup.CleanupJob.cleanup. Cleans up the given entry and returns the list of changes made. Annotations @Override

cleanup

back to summary

public List<FieldChange> cleanup(BibEntry entry)

Implements org.jabref.logic.cleanup.CleanupJob.cleanup.

Doc from org.jabref.logic.cleanup.CleanupJob.cleanup.

Cleans up the given entry and returns the list of changes made.

Annotations

@Override

cleanup back to summary

cleanup	back to summary
public List<FieldChange> cleanup(BibEntry entry, Consumer<Runnable> mutationScheduler) Overrides default org.jabref.logic.cleanup.CleanupJob.cleanup. Doc from org.jabref.logic.cleanup.CleanupJob.cleanup. Cleans up the given entry, routing all `BibEntry` field mutations through the provided scheduler. The scheduler must execute mutations synchronously (blocking the caller until complete), e.g. `UiTaskExecutor::runAndWaitInJavaFXThread` when called from a background thread, or `Runnable::run` when already on the correct thread. The default implementation wraps the entire `cleanup(BibEntry)` call in the scheduler, which is safe but puts all computation on the scheduler's thread. Override this method to keep expensive computation on the calling (background) thread and only schedule the actual field mutations. Annotations @Override

public List<FieldChange> cleanup(BibEntry entry, Consumer<Runnable> mutationScheduler)

Overrides default org.jabref.logic.cleanup.CleanupJob.cleanup.

Doc from org.jabref.logic.cleanup.CleanupJob.cleanup.

Cleans up the given entry, routing all BibEntry field mutations through the provided scheduler.

The scheduler must execute mutations synchronously (blocking the caller until complete), e.g. UiTaskExecutor::runAndWaitInJavaFXThread when called from a background thread, or Runnable::run when already on the correct thread.

The default implementation wraps the entire cleanup(BibEntry) call in the scheduler, which is safe but puts all computation on the scheduler's thread. Override this method to keep expensive computation on the calling (background) thread and only schedule the actual field mutations.

Annotations

@Override

cleanupAllFields	back to summary
private List<FieldChange> cleanupAllFields(BibEntry entry, Consumer<Runnable> mutationScheduler)

cleanupAllTextFields	back to summary
private List<FieldChange> cleanupAllTextFields(BibEntry entry, Consumer<Runnable> mutationScheduler)

cleanupSingleField	back to summary
private List<FieldChange> cleanupSingleField(Field fieldKey, BibEntry entry, Consumer<Runnable> mutationScheduler) Runs the formatter on the specified field in the given entry. If the formatter returns an empty string, then the field is removed. Parameters fieldKey:Field the field on which to run the formatter entry:BibEntry the entry to be cleaned up mutationScheduler:Consumer<Runnable> scheduler for field mutations (e.g. FX thread dispatch) Returns:List<FieldChange> a list of changes of the entry

cleanupSingleField

back to summary

private List<FieldChange> cleanupSingleField(Field fieldKey, BibEntry entry, Consumer<Runnable> mutationScheduler)

Runs the formatter on the specified field in the given entry.

If the formatter returns an empty string, then the field is removed.

Parameters

fieldKey:Field: the field on which to run the formatter
entry:BibEntry: the entry to be cleaned up
mutationScheduler:Consumer<Runnable>: scheduler for field mutations (e.g. FX thread dispatch)

Returns:List<FieldChange>

a list of changes of the entry

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getField	back to summary
public Field getField()

getFormatter	back to summary
public Formatter getFormatter()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class FieldFormatterCleanup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail