JabRef 5.15 · org.jabref.logic.cleanup.FieldFormatterCleanups

Modifier and Type	Field and Description
private final List<FieldFormatterCleanup>	actions
public static final List<FieldFormatterCleanup>	DEFAULT_SAVE_ACTIONS
public static final String	DISABLED
public static final String	ENABLED
private final boolean	enabled
private static final Pattern	FIELD_FORMATTER_CLEANUP_PATTERN This parses the key/list map of fields and clean up actions for the field.
private static final Logger	LOGGER
public static final List<FieldFormatterCleanup>	RECOMMEND_BIBLATEX_ACTIONS
public static final List<FieldFormatterCleanup>	RECOMMEND_BIBTEX_ACTIONS

Access	Constructor and Description
public	FieldFormatterCleanups(boolean enabled, List<FieldFormatterCleanup> actions)

Method Summary

Modifier and Type	Method and Description
private List<FieldChange>	applyAllActions(BibEntry entry)
public List<FieldChange>	applySaveActions(BibEntry entry)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public List<String>	getAsStringList(String delimiter)
public List<FieldFormatterCleanup>	getConfiguredActions()
pack-priv static Formatter	getFormatterFromString(String formatterName)
public static String	getMetaDataString(List<FieldFormatterCleanup> actionList, String newLineSeparator) Note String parsing is done at `FieldFormatterCleanups#parse(String)`
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEnabled()
public static List<FieldFormatterCleanup>	parse(String formatterString)
public static FieldFormatterCleanups	parse(List<String> formatterMetaList)
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 Detail

actions	back to summary
private final List<FieldFormatterCleanup> actions

DEFAULT_SAVE_ACTIONS	back to summary
public static final List<FieldFormatterCleanup> DEFAULT_SAVE_ACTIONS

DISABLED	back to summary
public static final String DISABLED

ENABLED	back to summary
public static final String ENABLED

enabled	back to summary
private final boolean enabled

FIELD_FORMATTER_CLEANUP_PATTERN back to summary

FIELD_FORMATTER_CLEANUP_PATTERN	back to summary
private static final Pattern FIELD_FORMATTER_CLEANUP_PATTERN This parses the key/list map of fields and clean up actions for the field. General format for one key/list map: `...[...]` - `field[formatter1,formatter2,...]` Multiple are written as `...[...]...[...]...[...]` `field1[formatter1,formatter2,...]field2[formatter3,formatter4,...]` The idea is that characters are field names until `[` is reached and that formatter lists are terminated by `]` Example: `pages[normalize_page_numbers]title[escapeAmpersands,escapeDollarSign,escapeUnderscores,latex_cleanup]`

private static final Pattern FIELD_FORMATTER_CLEANUP_PATTERN

This parses the key/list map of fields and clean up actions for the field.

General format for one key/list map: ...[...] - field[formatter1,formatter2,...] Multiple are written as ...[...]...[...]...[...] field1[formatter1,formatter2,...]field2[formatter3,formatter4,...]

The idea is that characters are field names until [ is reached and that formatter lists are terminated by ]

Example: pages[normalize_page_numbers]title[escapeAmpersands,escapeDollarSign,escapeUnderscores,latex_cleanup]

LOGGER	back to summary
private static final Logger LOGGER

RECOMMEND_BIBLATEX_ACTIONS	back to summary
public static final List<FieldFormatterCleanup> RECOMMEND_BIBLATEX_ACTIONS

RECOMMEND_BIBTEX_ACTIONS	back to summary
public static final List<FieldFormatterCleanup> RECOMMEND_BIBTEX_ACTIONS

Constructor Detail

FieldFormatterCleanups	back to summary
public FieldFormatterCleanups(boolean enabled, List<FieldFormatterCleanup> actions)

Method Detail

applyAllActions	back to summary
private List<FieldChange> applyAllActions(BibEntry entry)

applySaveActions	back to summary
public List<FieldChange> applySaveActions(BibEntry 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. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. 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.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAsStringList	back to summary
public List<String> getAsStringList(String delimiter)

getConfiguredActions	back to summary
public List<FieldFormatterCleanup> getConfiguredActions()

getFormatterFromString	back to summary
pack-priv static Formatter getFormatterFromString(String formatterName)

getMetaDataString	back to summary
public static String getMetaDataString(List<FieldFormatterCleanup> actionList, String newLineSeparator) Note String parsing is done at `FieldFormatterCleanups#parse(String)`

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. Returns:int a hash code value for this object 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.

Returns:int

a hash code value for this object

Annotations

@Override

isEnabled	back to summary
public boolean isEnabled()

parse	back to summary
public static List<FieldFormatterCleanup> parse(String formatterString)

parse	back to summary
public static FieldFormatterCleanups parse(List<String> formatterMetaList)

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. Returns:String a string representation of the object 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.

Returns:String

a string representation of the object

Annotations

@Override

public Class FieldFormatterCleanups

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail