Top Fields Constructors Methods
org.jabref.logic.layout.format

public Class ReplaceUnicodeLigaturesFormatter

extends Formatter
implements LayoutFormatter
Class Inheritance
All Implemented Interfaces
org.jabref.logic.layout.LayoutFormatter
Imports
java.util.HashMap, .Map, java.util.regex.Pattern, org.jabref.logic.cleanup.Formatter, org.jabref.logic.l10n.Localization, org.jabref.logic.layout.LayoutFormatter, org.jabref.logic.util.strings.UnicodeLigaturesMap

Field Summary

Modifier and TypeField and Description
private final Map<Pattern, String>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
format(String
The text to layout.
fieldText
)

Implements abstract org.jabref.logic.cleanup.Formatter.format.

Implements org.jabref.logic.layout.LayoutFormatter.format.

Failure Mode:

Formatters should be robust in the sense that they always return some relevant string.

public String
getDescription()

Implements abstract org.jabref.logic.cleanup.Formatter.getDescription.

Returns a description of the formatter.

public String
getExampleInput()

Implements abstract org.jabref.logic.cleanup.Formatter.getExampleInput.

Returns an example input string of the formatter.

public String
getKey()

Implements abstract org.jabref.logic.cleanup.Formatter.getKey.

Returns a unique key for the formatter that can be used for its identification

public String
getName()

Implements abstract org.jabref.logic.cleanup.Formatter.getName.

Returns a human readable name of the formatter usable for e.g. in the GUI

Inherited from org.jabref.logic.cleanup.Formatter:
equalshashCode

Field Detail

ligaturesMapback to summary
private final Map<Pattern, String> ligaturesMap

Constructor Detail

ReplaceUnicodeLigaturesFormatterback to summary
public ReplaceUnicodeLigaturesFormatter()

Method Detail

formatback to summary
public String format(String fieldText)

Implements abstract org.jabref.logic.cleanup.Formatter.format.

Implements org.jabref.logic.layout.LayoutFormatter.format.

Doc from org.jabref.logic.layout.LayoutFormatter.format.

Failure Mode:

Formatters should be robust in the sense that they always return some relevant string.

If the formatter can detect an invalid input it should return the original string otherwise it may simply return a wrong output.

Parameters
fieldText:String

The text to layout.

Returns:String

The layouted text.

Annotations
@Override
getDescriptionback to summary
public String getDescription()

Implements abstract org.jabref.logic.cleanup.Formatter.getDescription.

Doc from org.jabref.logic.cleanup.Formatter.getDescription.

Returns a description of the formatter.

Returns:String

the description string, always non empty

Annotations
@Override
getExampleInputback to summary
public String getExampleInput()

Implements abstract org.jabref.logic.cleanup.Formatter.getExampleInput.

Doc from org.jabref.logic.cleanup.Formatter.getExampleInput.

Returns an example input string of the formatter. This example is used as input to the formatter to demonstrate its functionality

Returns:String

the example input string, always non empty

Annotations
@Override
getKeyback to summary
public String getKey()

Implements abstract org.jabref.logic.cleanup.Formatter.getKey.

Doc from org.jabref.logic.cleanup.Formatter.getKey.

Returns a unique key for the formatter that can be used for its identification

Returns:String

the key of the formatter, always not null

Annotations
@Override
getNameback to summary
public String getName()

Implements abstract org.jabref.logic.cleanup.Formatter.getName.

Doc from org.jabref.logic.cleanup.Formatter.getName.

Returns a human readable name of the formatter usable for e.g. in the GUI

Returns:String

the name of the formatter, always not null

Annotations
@Override