Use raw Strings instead of Warnings

9 files changed, 30 insertions, 56 deletions

diff --git a/src/main/java/org/zwobble/mammoth/Result.java b/src/main/java/org/zwobble/mammoth/Result.java
index 486d155..2660fd4 100644
--- a/src/main/java/org/zwobble/mammoth/Result.java
+++ b/src/main/java/org/zwobble/mammoth/Result.java
@@ -1,10 +1,8 @@
 package org.zwobble.mammoth;
 
-import org.zwobble.mammoth.internal.results.Warning;
-
 import java.util.List;
 
 public interface Result<T> {
     T getValue();
-    List<Warning> getWarnings();
+    List<String> getWarnings();
 }
diff --git a/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java b/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java
index 6c4961a..45ff92e 100644
--- a/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java
+++ b/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java
@@ -8,7 +8,6 @@ import org.zwobble.mammoth.internal.documents.*;
 import org.zwobble.mammoth.internal.html.Html;
 import org.zwobble.mammoth.internal.html.HtmlNode;
 import org.zwobble.mammoth.internal.results.InternalResult;
-import org.zwobble.mammoth.internal.results.Warning;
 import org.zwobble.mammoth.internal.styles.HtmlPath;
 import org.zwobble.mammoth.internal.styles.StyleMap;
 import org.zwobble.mammoth.internal.util.MammothLists;
@@ -19,7 +18,6 @@ import java.util.Base64;
 import java.util.List;
 import java.util.Map;
 
-import static org.zwobble.mammoth.internal.results.Warning.warning;
 import static org.zwobble.mammoth.internal.util.MammothLists.*;
 import static org.zwobble.mammoth.internal.util.MammothMaps.map;
 
@@ -49,7 +47,7 @@ public class DocumentToHtml {
     private final boolean preserveEmptyParagraphs;
     private final StyleMap styleMap;
     private final List<NoteReference> noteReferences = new ArrayList<>();
-    private final ImmutableList.Builder<Warning> warnings = ImmutableList.builder();
+    private final ImmutableList.Builder<String> warnings = ImmutableList.builder();
 
     private DocumentToHtml(DocumentToHtmlOptions options) {
         this.idPrefix = options.idPrefix();
@@ -103,7 +101,7 @@ public class DocumentToHtml {
                 HtmlPath mapping = styleMap.getParagraphHtmlPath(paragraph)
                     .orElseGet(() -> {
                         if (paragraph.getStyle().isPresent()) {
-                            warnings.add(warning("Unrecognised paragraph style: " + paragraph.getStyle().get().describe()));
+                            warnings.add("Unrecognised paragraph style: " + paragraph.getStyle().get().describe());
                         }
                         return HtmlPath.element("p");
                     });
@@ -134,7 +132,7 @@ public class DocumentToHtml {
                 HtmlPath mapping = styleMap.getRunHtmlPath(run)
                     .orElseGet(() -> {
                         if (run.getStyle().isPresent()) {
-                            warnings.add(warning("Unrecognised run style: " + run.getStyle().get().describe()));
+                            warnings.add("Unrecognised run style: " + run.getStyle().get().describe());
                         }
                         return HtmlPath.EMPTY;
                     });
@@ -224,7 +222,7 @@ public class DocumentToHtml {
 
                             return list(Html.selfClosingElement("img", attributes.build()));
                         } catch (IOException exception) {
-                            warnings.add(warning(exception.getMessage()));
+                            warnings.add(exception.getMessage());
                             return MammothLists.<HtmlNode>list();
                         }
                     })
diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java b/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java
index c8aa57e..0edc7a7 100644
--- a/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java
+++ b/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java
@@ -3,7 +3,6 @@ package org.zwobble.mammoth.internal.docx;
 import com.google.common.collect.ImmutableSet;
 import org.zwobble.mammoth.internal.documents.*;
 import org.zwobble.mammoth.internal.results.InternalResult;
-import org.zwobble.mammoth.internal.results.Warning;
 import org.zwobble.mammoth.internal.util.InputStreamSupplier;
 import org.zwobble.mammoth.internal.util.MammothOptionals;
 import org.zwobble.mammoth.internal.xml.XmlElement;
@@ -19,7 +18,6 @@ import static com.google.common.collect.Iterables.filter;
 import static com.google.common.collect.Iterables.transform;
 import static org.zwobble.mammoth.internal.docx.ReadResult.EMPTY_SUCCESS;
 import static org.zwobble.mammoth.internal.docx.ReadResult.success;
-import static org.zwobble.mammoth.internal.results.Warning.warning;
 import static org.zwobble.mammoth.internal.util.MammothLists.list;
 import static org.zwobble.mammoth.internal.util.MammothStrings.trimLeft;
 
@@ -120,7 +118,7 @@ public class BodyXmlReader {
                 return EMPTY_SUCCESS;
 
             default:
-                Warning warning = warning("An unrecognised element was ignored: " + element.getName());
+                String warning = "An unrecognised element was ignored: " + element.getName();
                 return ReadResult.emptyWithWarning(warning);
         }
     }
@@ -215,7 +213,7 @@ public class BodyXmlReader {
         } else {
             return new InternalResult<>(
                 Optional.of(new Style(styleId, Optional.empty())),
-                list(warning(styleType + " style with ID " + styleId + " was referenced but not defined in the document")));
+                list(styleType + " style with ID " + styleId + " was referenced but not defined in the document"));
         }
 
     }
@@ -233,7 +231,7 @@ public class BodyXmlReader {
         if (breakType.equals("")) {
             return success(LineBreak.LINE_BREAK);
         } else {
-            return ReadResult.emptyWithWarning(warning("Unsupported break type: " + breakType));
+            return ReadResult.emptyWithWarning("Unsupported break type: " + breakType);
         }
     }
 
@@ -314,7 +312,7 @@ public class BodyXmlReader {
         if (IMAGE_TYPES_SUPPORTED_BY_BROWSERS.contains(contentTypeString)) {
             return success(image);
         } else {
-            return ReadResult.withWarning(image, warning("Image of type " + contentTypeString + " is unlikely to display in web browsers"));
+            return ReadResult.withWarning(image, "Image of type " + contentTypeString + " is unlikely to display in web browsers");
         }
     }
 
diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/ReadResult.java b/src/main/java/org/zwobble/mammoth/internal/docx/ReadResult.java
index b9e4ec9..b390649 100644
--- a/src/main/java/org/zwobble/mammoth/internal/docx/ReadResult.java
+++ b/src/main/java/org/zwobble/mammoth/internal/docx/ReadResult.java
@@ -3,7 +3,6 @@ package org.zwobble.mammoth.internal.docx;
 import com.google.common.collect.ImmutableList;
 import org.zwobble.mammoth.internal.documents.DocumentElement;
 import org.zwobble.mammoth.internal.results.InternalResult;
-import org.zwobble.mammoth.internal.results.Warning;
 
 import java.util.List;
 import java.util.function.BiFunction;
@@ -17,7 +16,7 @@ public class ReadResult {
     public static ReadResult concat(Iterable<ReadResult> results) {
         ImmutableList.Builder<DocumentElement> elements = ImmutableList.builder();
         ImmutableList.Builder<DocumentElement> extra = ImmutableList.builder();
-        ImmutableList.Builder<Warning> warnings = ImmutableList.builder();
+        ImmutableList.Builder<String> warnings = ImmutableList.builder();
         for (ReadResult result : results) {
             elements.addAll(result.elements);
             extra.addAll(result.extra);
@@ -45,19 +44,19 @@ public class ReadResult {
         return new ReadResult(elements, list(), list());
     }
 
-    public static ReadResult emptyWithWarning(Warning warning) {
+    public static ReadResult emptyWithWarning(String warning) {
         return new ReadResult(list(), list(), list(warning));
     }
 
-    public static ReadResult withWarning(DocumentElement element, Warning warning) {
+    public static ReadResult withWarning(DocumentElement element, String warning) {
         return new ReadResult(list(element), list(), list(warning));
     }
 
     private final List<DocumentElement> elements;
     private final List<DocumentElement> extra;
-    private final List<Warning> warnings;
+    private final List<String> warnings;
 
-    public ReadResult(List<DocumentElement> elements, List<DocumentElement> extra, List<Warning> warnings) {
+    public ReadResult(List<DocumentElement> elements, List<DocumentElement> extra, List<String> warnings) {
         this.elements = elements;
         this.extra = extra;
         this.warnings = warnings;
diff --git a/src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java b/src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java
index b3c9ec7..279692b 100644
--- a/src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java
+++ b/src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java
@@ -14,7 +14,7 @@ import static org.zwobble.mammoth.internal.util.MammothLists.list;
 public class InternalResult<T> implements org.zwobble.mammoth.Result<T> {
     public static <T> InternalResult<List<T>> concat(Iterable<InternalResult<T>> results) {
         ImmutableList.Builder<T> elements = ImmutableList.builder();
-        ImmutableList.Builder<Warning> warnings = ImmutableList.builder();
+        ImmutableList.Builder<String> warnings = ImmutableList.builder();
         for (InternalResult<T> result : results) {
             elements.add(result.value);
             warnings.addAll(result.warnings);
@@ -41,9 +41,9 @@ public class InternalResult<T> implements org.zwobble.mammoth.Result<T> {
     }
 
     private final T value;
-    private final List<Warning> warnings;
+    private final List<String> warnings;
 
-    public InternalResult(T value, List<Warning> warnings) {
+    public InternalResult(T value, List<String> warnings) {
         this.value = value;
         this.warnings = warnings;
     }
@@ -52,7 +52,7 @@ public class InternalResult<T> implements org.zwobble.mammoth.Result<T> {
         return value;
     }
 
-    public List<Warning> getWarnings() {
+    public List<String> getWarnings() {
         return warnings;
     }
 
diff --git a/src/main/java/org/zwobble/mammoth/internal/results/Warning.java b/src/main/java/org/zwobble/mammoth/internal/results/Warning.java
deleted file mode 100644
index 062860f..0000000
--- a/src/main/java/org/zwobble/mammoth/internal/results/Warning.java
+++ /dev/null
@@ -1,16 +0,0 @@
-package org.zwobble.mammoth.internal.results;
-
-public class Warning {
-    public static Warning warning(String message) {
-        return new Warning(message);
-    }
-    private final String message;
-
-    private Warning(String message) {
-        this.message = message;
-    }
-
-    public String getMessage() {
-        return message;
-    }
-}
diff --git a/src/test/java/org/zwobble/mammoth/tests/DocumentConverterTests.java b/src/test/java/org/zwobble/mammoth/tests/DocumentConverterTests.java
index 526c078..befba22 100644
--- a/src/test/java/org/zwobble/mammoth/tests/DocumentConverterTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/DocumentConverterTests.java
@@ -22,11 +22,10 @@ import static org.hamcrest.Matchers.*;
 import static org.zwobble.mammoth.internal.documents.VerticalAlignment.SUBSCRIPT;
 import static org.zwobble.mammoth.internal.documents.VerticalAlignment.SUPERSCRIPT;
 import static org.zwobble.mammoth.internal.results.InternalResult.success;
-import static org.zwobble.mammoth.internal.results.Warning.warning;
-import static org.zwobble.mammoth.tests.DeepReflectionMatcher.deepEquals;
-import static org.zwobble.mammoth.tests.documents.DocumentElementMakers.*;
 import static org.zwobble.mammoth.internal.util.MammothLists.list;
 import static org.zwobble.mammoth.internal.util.MammothMaps.map;
+import static org.zwobble.mammoth.tests.DeepReflectionMatcher.deepEquals;
+import static org.zwobble.mammoth.tests.documents.DocumentElementMakers.*;
 
 public class DocumentConverterTests {
     // TODO: styles (paragraph, run)
@@ -80,7 +79,7 @@ public class DocumentConverterTests {
 
             deepEquals(new InternalResult<>(
                 list(Html.element("p")),
-                list(warning("Unrecognised paragraph style: Tips Paragraph (Style ID: TipsParagraph)")))));
+                list("Unrecognised paragraph style: Tips Paragraph (Style ID: TipsParagraph)"))));
     }
 
     @Test
@@ -107,7 +106,7 @@ public class DocumentConverterTests {
 
             deepEquals(new InternalResult<>(
                 list(Html.text("Hello")),
-                list(warning("Unrecognised run style: Tips Run (Style ID: TipsRun)")))));
+                list("Unrecognised run style: Tips Run (Style ID: TipsRun)"))));
     }
 
     @Test
diff --git a/src/test/java/org/zwobble/mammoth/tests/MammothTests.java b/src/test/java/org/zwobble/mammoth/tests/MammothTests.java
index e8287e8..bc997a2 100644
--- a/src/test/java/org/zwobble/mammoth/tests/MammothTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/MammothTests.java
@@ -97,7 +97,7 @@ public class MammothTests {
                 allOf(
                     hasProperty("value", equalTo("")),
                     hasProperty("warnings", contains(
-                        hasProperty("message", startsWith("could not open external image 'tiny-picture.png': path of document is unknown, but is required for relative URI"))))));
+                        startsWith("could not open external image 'tiny-picture.png': path of document is unknown, but is required for relative URI")))));
         } finally {
             tempDirectory.toFile().delete();
         }
@@ -114,7 +114,7 @@ public class MammothTests {
                 allOf(
                     hasProperty("value", equalTo("")),
                     hasProperty("warnings", contains(
-                        hasProperty("message", startsWith("could not open external image 'tiny-picture.png'"))))));
+                        startsWith("could not open external image 'tiny-picture.png'")))));
         } finally {
             tempDirectory.toFile().delete();
         }
diff --git a/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java b/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java
index 4c9d621..049db81 100644
--- a/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java
@@ -8,7 +8,6 @@ import org.junit.Test;
 import org.zwobble.mammoth.internal.documents.*;
 import org.zwobble.mammoth.internal.docx.*;
 import org.zwobble.mammoth.internal.results.InternalResult;
-import org.zwobble.mammoth.internal.results.Warning;
 import org.zwobble.mammoth.tests.DeepReflectionMatcher;
 import org.zwobble.mammoth.internal.xml.XmlElement;
 import org.zwobble.mammoth.internal.xml.XmlNode;
@@ -29,7 +28,6 @@ import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.hasProperty;
 import static org.zwobble.mammoth.internal.documents.NoteReference.endnoteReference;
 import static org.zwobble.mammoth.internal.documents.NoteReference.footnoteReference;
-import static org.zwobble.mammoth.internal.results.Warning.warning;
 import static org.zwobble.mammoth.tests.DeepReflectionMatcher.deepEquals;
 import static org.zwobble.mammoth.tests.documents.DocumentElementMakers.*;
 import static org.zwobble.mammoth.tests.docx.BodyXmlReaderMakers.*;
@@ -94,7 +92,7 @@ public class BodyXmlTests {
             read(a(bodyReader), element),
             isResult(
                 hasStyle(Optional.of(new Style("Heading1", Optional.empty()))),
-                list(warning("Paragraph style with ID Heading1 was referenced but not defined in the document"))));
+                list("Paragraph style with ID Heading1 was referenced but not defined in the document")));
     }
 
     @Test
@@ -183,7 +181,7 @@ public class BodyXmlTests {
             read(a(bodyReader), element),
             isResult(
                 hasStyle(Optional.of(new Style("Heading1Char", Optional.empty()))),
-                list(warning("Run style with ID Heading1Char was referenced but not defined in the document"))));
+                list("Run style with ID Heading1Char was referenced but not defined in the document")));
     }
 
     @Test
@@ -311,7 +309,7 @@ public class BodyXmlTests {
 
         assertThat(
             readAll(a(bodyReader), element),
-            isResult(equalTo(list()), list(warning("Unsupported break type: page"))));
+            isResult(equalTo(list()), list("Unsupported break type: page")));
     }
 
     @Test
@@ -477,7 +475,7 @@ public class BodyXmlTests {
 
         assertThat(
             result,
-            hasProperty("warnings", deepEquals(list(warning("Image of type image/x-emf is unlikely to display in web browsers")))));
+            hasProperty("warnings", deepEquals(list("Image of type image/x-emf is unlikely to display in web browsers"))));
     }
 
     @Test
@@ -583,7 +581,7 @@ public class BodyXmlTests {
         XmlElement element = element("w:huh");
         assertThat(
             readAll(a(bodyReader), element),
-            isResult(equalTo(list()), list(warning("An unrecognised element was ignored: w:huh"))));
+            isResult(equalTo(list()), list("An unrecognised element was ignored: w:huh")));
     }
 
     @Test
@@ -654,7 +652,7 @@ public class BodyXmlTests {
         return hasProperty("numbering", deepEquals(expected));
     }
 
-    private <T> Matcher<InternalResult<? extends T>> isResult(Matcher<T> valueMatcher, List<Warning> warnings) {
+    private <T> Matcher<InternalResult<? extends T>> isResult(Matcher<T> valueMatcher, List<String> warnings) {
         return Matchers.allOf(
             hasProperty("value", valueMatcher),
             hasProperty("warnings", deepEquals(warnings)));