Add comment for binary-based importers (#12446)

JabRef · Feb 3, 2025 · e3ceea2 · e3ceea2
1 parent 30b951f
commit e3ceea2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/org/jabref/logic/importer/Importer.java b/src/main/java/org/jabref/logic/importer/Importer.java
@@ -77,6 +77,12 @@ public boolean isRecognizedFormat(String data) throws IOException {
      * <p>
      * If importing in a specified format and an empty library is returned, JabRef reports that no entries were found.
      * <p>
+     * If your format is binary-based (PDF, ZIP-based, or others), then you should not solely override this method.
+     * For binary formats do this:
+     * 1. Throw {@link UnsupportedOperationException} in this method.
+     * 2. Override the method {@link Importer#importDatabase(Path)}.
+     * Example of this workaround is in: {@link org.jabref.logic.importer.fileformat.pdf.PdfImporter}.
+     * <p>
      * This method should never return null.
      *
      * @param input the input to read from