Merge pull request #4044 from JabRef/feature/abstract-formatter

Streamline formatter implementation

src/main/java/org/jabref/logic/formatter/IdentityFormatter.java

@@ -8,7 +8,7 @@
 /**
  * It may seem useless, but is needed as a fallback option
  */
-public class IdentityFormatter implements Formatter {
+public class IdentityFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -35,15 +35,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "JabRef";
     }
-
-    @Override
-    public int hashCode() {
-        return defaultHashCode();
-    }
-
-    @Override
-    public boolean equals(Object obj) {
-        return defaultEquals(obj);
-    }
-
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/AddBracesFormatter.java

@@ -5,7 +5,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class AddBracesFormatter implements Formatter {
+public class AddBracesFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -38,5 +38,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "In CDMA";
     }
-
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/ClearFormatter.java

@@ -5,7 +5,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class ClearFormatter implements Formatter {
+public class ClearFormatter extends Formatter {
 
     @Override
     public String getName() {

src/main/java/org/jabref/logic/formatter/bibtexfields/EscapeUnderscoresFormatter.java

@@ -6,7 +6,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class EscapeUnderscoresFormatter implements Formatter {
+public class EscapeUnderscoresFormatter extends Formatter {
 
     private static final Pattern UNDERSCORES = Pattern.compile("_");
 

src/main/java/org/jabref/logic/formatter/bibtexfields/HtmlToLatexFormatter.java

@@ -13,7 +13,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class HtmlToLatexFormatter implements LayoutFormatter, Formatter {
+public class HtmlToLatexFormatter extends Formatter implements LayoutFormatter {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(HtmlToLatexFormatter.class);
 

src/main/java/org/jabref/logic/formatter/bibtexfields/HtmlToUnicodeFormatter.java

@@ -8,7 +8,7 @@
 import org.apache.commons.lang3.StringEscapeUtils;
 
 @ApacheCommonsLang3Allowed("There is no equivalent in Google's Guava")
-public class HtmlToUnicodeFormatter implements LayoutFormatter, Formatter {
+public class HtmlToUnicodeFormatter extends Formatter implements LayoutFormatter {
 
     @Override
     public String getName() {

src/main/java/org/jabref/logic/formatter/bibtexfields/LatexCleanupFormatter.java

@@ -5,7 +5,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class LatexCleanupFormatter implements Formatter {
+public class LatexCleanupFormatter extends Formatter {
 
     private static final Pattern REMOVE_REDUNDANT = Pattern
             .compile("(?<!\\\\[\\p{Alpha}]{0,100}\\{[^\\}]{0,100})\\}([-/ ]?)\\{");
@@ -62,5 +62,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "{VLSI} {DSP}";
     }
-
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/NormalizeDateFormatter.java

@@ -9,7 +9,7 @@
 /**
  * This class transforms date to the format yyyy-mm-dd or yyyy-mm..
  */
-public class NormalizeDateFormatter implements Formatter {
+public class NormalizeDateFormatter extends Formatter {
     @Override
     public String getName() {
         return Localization.lang("Normalize date");
@@ -43,14 +43,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "29.11.2003";
     }
-
-    @Override
-    public int hashCode() {
-        return defaultHashCode();
-    }
-
-    @Override
-    public boolean equals(Object obj) {
-        return defaultEquals(obj);
-    }
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/NormalizeMonthFormatter.java

@@ -7,7 +7,7 @@
 import org.jabref.model.cleanup.Formatter;
 import org.jabref.model.entry.Month;
 
-public class NormalizeMonthFormatter implements Formatter {
+public class NormalizeMonthFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -35,5 +35,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "December";
     }
-
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/NormalizeNamesFormatter.java

@@ -9,7 +9,7 @@
 /**
  * Formatter normalizing a list of person names to the BibTeX format.
  */
-public class NormalizeNamesFormatter implements Formatter {
+public class NormalizeNamesFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -37,5 +37,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "Albert Einstein and Alan Turing";
     }
-
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/NormalizePagesFormatter.java

@@ -18,7 +18,7 @@
  * To make it easier to maintain Scribe-compatible databases, the standard styles convert
  * a single dash (as in 7-33) to the double dash used in TEX to denote number ranges (as in 7--33).
  */
-public class NormalizePagesFormatter implements Formatter {
+public class NormalizePagesFormatter extends Formatter {
 
     // "startpage" and "endpage" are named groups. See http://stackoverflow.com/a/415635/873282 for a documentation
     private static final Pattern PAGES_DETECT_PATTERN = Pattern.compile("\\A(?<startpage>(\\d+:)?\\d+)(?:-{1,2}(?<endpage>(\\d+:)?\\d+))?\\Z");
@@ -61,7 +61,7 @@ public String format(String value) {
         }
 
         // Remove pages prefix
-        String cleanValue = value.replace("pp.", "").replace("p.","");
+        String cleanValue = value.replace("pp.", "").replace("p.", "");
         // remove unwanted literals incl. whitespace
         cleanValue = cleanValue.replaceAll("\u2013|\u2014", "-").replaceAll(REJECT_LITERALS, "");
         // try to find pages pattern
@@ -87,14 +87,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "1 - 2";
     }
-
-    @Override
-    public int hashCode() {
-        return defaultHashCode();
-    }
-
-    @Override
-    public boolean equals(Object obj) {
-        return defaultEquals(obj);
-    }
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/OrdinalsToSuperscriptFormatter.java

@@ -10,7 +10,7 @@
 /**
  * This class transforms ordinal numbers into LaTex superscripts.
  */
-public class OrdinalsToSuperscriptFormatter implements Formatter {
+public class OrdinalsToSuperscriptFormatter extends Formatter {
 
     // find possible superscripts on word boundaries
     private static final Pattern SUPERSCRIPT_DETECT_PATTERN = Pattern.compile("\\b(\\d+)(st|nd|rd|th)\\b",
@@ -61,5 +61,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "11th";
     }
-
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/RegexFormatter.java

@@ -9,7 +9,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class RegexFormatter implements Formatter {
+public class RegexFormatter extends Formatter {
 
     private static final Pattern PATTERN_ESCAPED_OPENING_CURLY_BRACE = Pattern.compile("\\\\\\{");
 
@@ -101,5 +101,4 @@ public static void setRegex(String rex) {
         String[] parts = rexToSet.split("\",\"");
         regex = parts;
     }
-
 }

src/main/java/org/jabref/logic/formatter/bibtexfields/RemoveBracesFormatter.java

@@ -5,7 +5,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class RemoveBracesFormatter implements Formatter {
+public class RemoveBracesFormatter extends Formatter {
 
     @Override
     public String getName() {

src/main/java/org/jabref/logic/formatter/bibtexfields/RemoveHyphenatedNewlinesFormatter.java

@@ -9,7 +9,7 @@
 /**
  * Removes all hyphenated line breaks in the string.
  */
-public class RemoveHyphenatedNewlinesFormatter implements Formatter {
+public class RemoveHyphenatedNewlinesFormatter extends Formatter {
     private static final Pattern HYPHENATED_WORDS = Pattern.compile("(-\r\n|-\n|-\r)");
 
     @Override

src/main/java/org/jabref/logic/formatter/bibtexfields/RemoveNewlinesFormatter.java

@@ -9,7 +9,7 @@
 /**
  * Removes all line breaks in the string.
  */
-public class RemoveNewlinesFormatter implements Formatter {
+public class RemoveNewlinesFormatter extends Formatter {
     private static final Pattern LINEBREAKS = Pattern.compile("(\r?\n|\r)");
 
     @Override

src/main/java/org/jabref/logic/formatter/bibtexfields/UnicodeToLatexFormatter.java

@@ -11,7 +11,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class UnicodeToLatexFormatter implements LayoutFormatter, Formatter {
+public class UnicodeToLatexFormatter extends Formatter implements LayoutFormatter {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(UnicodeToLatexFormatter.class);
 

src/main/java/org/jabref/logic/formatter/bibtexfields/UnitsToLatexFormatter.java

@@ -10,7 +10,7 @@
 import org.jabref.logic.util.strings.StringLengthComparator;
 import org.jabref.model.cleanup.Formatter;
 
-public class UnitsToLatexFormatter implements Formatter {
+public class UnitsToLatexFormatter extends Formatter {
 
     private static final List<String> UNIT_LIST = Arrays.asList(
             "A", // Ampere
@@ -81,7 +81,6 @@ public class UnitsToLatexFormatter implements Formatter {
 
     private final List<String> prefixUnitCombinations;
 
-
     public UnitsToLatexFormatter() {
         prefixUnitCombinations = new ArrayList<>(
                 UnitsToLatexFormatter.UNIT_LIST.size() * UnitsToLatexFormatter.UNIT_PREFIX_LIST.size());
@@ -112,7 +111,6 @@ public String format(String text) {
             result = result.replaceAll("([0-9])(" + listOfWord + ")", "$1\\{$2\\}"); // Only add brackets to keep case
             result = result.replaceAll("([0-9])-(" + listOfWord + ")", "$1\\\\mbox\\{-\\}\\{$2\\}"); // Replace hyphen with non-break hyphen
             result = result.replaceAll("([0-9]) (" + listOfWord + ")", "$1~\\{$2\\}"); // Replace space with a hard space
-
         }
 
         return result;
@@ -137,5 +135,4 @@ public String getName() {
     public String getKey() {
         return "units_to_latex";
     }
-
 }

src/main/java/org/jabref/logic/formatter/casechanger/CapitalizeFormatter.java

@@ -3,7 +3,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class CapitalizeFormatter implements Formatter {
+public class CapitalizeFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -37,5 +37,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "I have {a} DREAM";
     }
-
 }

src/main/java/org/jabref/logic/formatter/casechanger/LowerCaseFormatter.java

@@ -3,7 +3,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class LowerCaseFormatter implements Formatter {
+public class LowerCaseFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -27,16 +27,6 @@ public String format(String input) {
         return title.toString();
     }
 
-    @Override
-    public int hashCode() {
-        return defaultHashCode();
-    }
-
-    @Override
-    public boolean equals(Object obj) {
-        return defaultEquals(obj);
-    }
-
     @Override
     public String getDescription() {
         return Localization.lang("Changes all letters to lower case.");
@@ -46,5 +36,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "KDE {Amarok}";
     }
-
 }

src/main/java/org/jabref/logic/formatter/casechanger/ProtectTermsFormatter.java

@@ -8,7 +8,7 @@
 import org.jabref.logic.util.strings.StringLengthComparator;
 import org.jabref.model.cleanup.Formatter;
 
-public class ProtectTermsFormatter implements Formatter {
+public class ProtectTermsFormatter extends Formatter {
 
     private final ProtectedTermsLoader protectedTermsLoader;
 
@@ -56,5 +56,4 @@ public String getName() {
     public String getKey() {
         return "protect_terms";
     }
-
 }

src/main/java/org/jabref/logic/formatter/casechanger/SentenceCaseFormatter.java

@@ -3,7 +3,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class SentenceCaseFormatter implements Formatter {
+public class SentenceCaseFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -37,5 +37,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "i have {Aa} DREAM";
     }
-
 }

src/main/java/org/jabref/logic/formatter/casechanger/TitleCaseFormatter.java

@@ -3,7 +3,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class TitleCaseFormatter implements Formatter {
+public class TitleCaseFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -49,5 +49,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "{BPMN} conformance In open source Engines";
     }
-
 }

src/main/java/org/jabref/logic/formatter/casechanger/UpperCaseFormatter.java

@@ -3,7 +3,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.cleanup.Formatter;
 
-public class UpperCaseFormatter implements Formatter {
+public class UpperCaseFormatter extends Formatter {
 
     @Override
     public String getName() {
@@ -37,5 +37,4 @@ public String getDescription() {
     public String getExampleInput() {
         return "Kde {Amarok}";
     }
-
 }

src/main/java/org/jabref/logic/formatter/minifier/MinifyNameListFormatter.java

@@ -8,7 +8,7 @@
 /**
  * Replaces three or more authors with and others
  */
-public class MinifyNameListFormatter implements Formatter {
+public class MinifyNameListFormatter extends Formatter {
     @Override
     public String getName() {
         return Localization.lang("Minify list of person names");

src/main/java/org/jabref/logic/layout/format/LatexToUnicodeFormatter.java

@@ -9,7 +9,7 @@
  * This formatter converts LaTeX character sequences their equivalent unicode characters,
  * and removes other LaTeX commands without handling them.
  */
-public class LatexToUnicodeFormatter implements LayoutFormatter, Formatter {
+public class LatexToUnicodeFormatter extends Formatter implements LayoutFormatter {
 
     @Override
     public String getName() {