Top Description Fields Constructors Methods
org.jabref.logic.formatter.casechanger

public Class ProtectTermsFormatter

extends Formatter
Class Inheritance
Imports
java.util.List, .Objects, org.jabref.logic.cleanup.Formatter, org.jabref.logic.l10n.Localization, org.jabref.logic.protectedterms.ProtectedTermsLoader, org.jabref.logic.util.strings.StringLengthComparator
Adds {} brackets around acronyms, month names and countries to preserve their case. Related formatter: org.jabref.logic.formatter.bibtexfields.RemoveBracesFormatter

Field Summary

Modifier and TypeField and Description
private final ProtectedTermsLoader
protectedTermsLoader

Constructor Summary

AccessConstructor and Description
public
ProtectTermsFormatter(ProtectedTermsLoader protectedTermsLoader)

Method Summary

Modifier and TypeMethod and Description
private String
format(String text, List<String> listOfWords)

public String
format(String
the input String
text)

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

Formats a field value by with a particular formatter transformation.

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

protectedTermsLoaderback to summary
private final ProtectedTermsLoader protectedTermsLoader

Constructor Detail

ProtectTermsFormatterback to summary
public ProtectTermsFormatter(ProtectedTermsLoader protectedTermsLoader)

Method Detail

formatback to summary
private String format(String text, List<String> listOfWords)
formatback to summary
public String format(String text)

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

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

Formats a field value by with a particular formatter transformation.

Calling this method with a null argument results in a NullPointerException.

Parameters
text:String

the input String

Returns:String

the formatted output String

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