From 86207d30715fe000b95b2f8e8b55b59a21aba34b Mon Sep 17 00:00:00 2001
From: Michael Williamson <mike@zwobble.org>
Date: Wed, 24 Feb 2016 21:03:42 +0000
Subject: Turn Result into a minimal interface

---
 .../org/zwobble/mammoth/DocumentConverter.java     |  4 +-
 src/main/java/org/zwobble/mammoth/Result.java      | 10 ++++
 .../zwobble/mammoth/internal/DocumentToHtml.java   | 14 ++---
 .../mammoth/internal/docx/BodyXmlReader.java       | 20 +++----
 .../mammoth/internal/docx/DocumentReader.java      | 12 ++--
 .../mammoth/internal/docx/DocumentXmlReader.java   |  4 +-
 .../mammoth/internal/docx/NotesXmlReader.java      |  8 +--
 .../zwobble/mammoth/internal/docx/ReadResult.java  | 10 ++--
 .../mammoth/internal/results/InternalResult.java   | 69 ++++++++++++++++++++++
 .../zwobble/mammoth/internal/results/Warning.java  | 16 +++++
 .../java/org/zwobble/mammoth/results/Result.java   | 69 ----------------------
 .../java/org/zwobble/mammoth/results/Warning.java  | 16 -----
 .../mammoth/tests/DocumentConverterTests.java      | 18 +++---
 .../org/zwobble/mammoth/tests/MammothTests.java    |  4 +-
 .../zwobble/mammoth/tests/docx/BodyXmlTests.java   | 18 +++---
 .../mammoth/tests/docx/DocumentXmlTests.java       |  8 +--
 .../mammoth/tests/docx/NotesXmlReaderTests.java    |  8 +--
 17 files changed, 159 insertions(+), 149 deletions(-)
 create mode 100644 src/main/java/org/zwobble/mammoth/Result.java
 create mode 100644 src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java
 create mode 100644 src/main/java/org/zwobble/mammoth/internal/results/Warning.java
 delete mode 100644 src/main/java/org/zwobble/mammoth/results/Result.java
 delete mode 100644 src/main/java/org/zwobble/mammoth/results/Warning.java

(limited to 'src')

diff --git a/src/main/java/org/zwobble/mammoth/DocumentConverter.java b/src/main/java/org/zwobble/mammoth/DocumentConverter.java
index 31464e7..84f8570 100644
--- a/src/main/java/org/zwobble/mammoth/DocumentConverter.java
+++ b/src/main/java/org/zwobble/mammoth/DocumentConverter.java
@@ -14,7 +14,7 @@ import org.zwobble.mammoth.internal.docx.ZippedDocxFile;
 import org.zwobble.mammoth.internal.html.Html;
 import org.zwobble.mammoth.internal.styles.DefaultStyles;
 import org.zwobble.mammoth.internal.util.Casts;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.internal.results.InternalResult;
 
 import java.io.File;
 import java.io.IOException;
@@ -60,7 +60,7 @@ public class DocumentConverter {
             convertToHtml(Optional.of(file.toPath()), zipFile));
     }
 
-    private Result<String> convertToHtml(Optional<Path> path, DocxFile zipFile) {
+    private InternalResult<String> convertToHtml(Optional<Path> path, DocxFile zipFile) {
         return readDocument(path, zipFile)
             .flatMap(nodes -> DocumentToHtml.convertToHtml(nodes, options))
             .map(Html::stripEmpty)
diff --git a/src/main/java/org/zwobble/mammoth/Result.java b/src/main/java/org/zwobble/mammoth/Result.java
new file mode 100644
index 0000000..486d155
--- /dev/null
+++ b/src/main/java/org/zwobble/mammoth/Result.java
@@ -0,0 +1,10 @@
+package org.zwobble.mammoth;
+
+import org.zwobble.mammoth.internal.results.Warning;
+
+import java.util.List;
+
+public interface Result<T> {
+    T getValue();
+    List<Warning> getWarnings();
+}
diff --git a/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java b/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java
index b501800..6c4961a 100644
--- a/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java
+++ b/src/main/java/org/zwobble/mammoth/internal/DocumentToHtml.java
@@ -7,8 +7,8 @@ import com.google.common.io.ByteStreams;
 import org.zwobble.mammoth.internal.documents.*;
 import org.zwobble.mammoth.internal.html.Html;
 import org.zwobble.mammoth.internal.html.HtmlNode;
-import org.zwobble.mammoth.results.Result;
-import org.zwobble.mammoth.results.Warning;
+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,14 +19,14 @@ import java.util.Base64;
 import java.util.List;
 import java.util.Map;
 
-import static org.zwobble.mammoth.results.Warning.warning;
+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;
 
 public class DocumentToHtml {
-    public static Result<List<HtmlNode>> convertToHtml(Document document, DocumentToHtmlOptions options) {
+    public static InternalResult<List<HtmlNode>> convertToHtml(Document document, DocumentToHtmlOptions options) {
         DocumentToHtml documentConverter = new DocumentToHtml(options);
-        return new Result<>(
+        return new InternalResult<>(
             documentConverter.convertToHtml(document),
             documentConverter.warnings.build());
     }
@@ -38,9 +38,9 @@ public class DocumentToHtml {
             reference -> document.getNotes().findNote(reference.getNoteType(), reference.getNoteId()).get()));
     }
 
-    public static Result<List<HtmlNode>> convertToHtml(DocumentElement element, DocumentToHtmlOptions options) {
+    public static InternalResult<List<HtmlNode>> convertToHtml(DocumentElement element, DocumentToHtmlOptions options) {
         DocumentToHtml documentConverter = new DocumentToHtml(options);
-        return new Result<>(
+        return new InternalResult<>(
             documentConverter.convertToHtml(element),
             documentConverter.warnings.build());
     }
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 43a275a..c8aa57e 100644
--- a/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java
+++ b/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java
@@ -2,8 +2,8 @@ package org.zwobble.mammoth.internal.docx;
 
 import com.google.common.collect.ImmutableSet;
 import org.zwobble.mammoth.internal.documents.*;
-import org.zwobble.mammoth.results.Result;
-import org.zwobble.mammoth.results.Warning;
+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 +19,7 @@ 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.results.Warning.warning;
+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;
 
@@ -169,7 +169,7 @@ public class BodyXmlReader {
         }
     }
 
-    private Result<Optional<Style>> readRunStyle(XmlElementLike properties) {
+    private InternalResult<Optional<Style>> readRunStyle(XmlElementLike properties) {
         return readStyle(properties, "w:rStyle", "Run", styles::findCharacterStyleById);
     }
 
@@ -189,11 +189,11 @@ public class BodyXmlReader {
             (style, children) -> new Paragraph(style, numbering, children)).appendExtra();
     }
 
-    private Result<Optional<Style>> readParagraphStyle(XmlElementLike properties) {
+    private InternalResult<Optional<Style>> readParagraphStyle(XmlElementLike properties) {
         return readStyle(properties, "w:pStyle", "Paragraph", styles::findParagraphStyleById);
     }
 
-    private Result<Optional<Style>> readStyle(
+    private InternalResult<Optional<Style>> readStyle(
         XmlElementLike properties,
         String styleTagName,
         String styleType,
@@ -201,19 +201,19 @@ public class BodyXmlReader {
     {
         return readVal(properties, styleTagName)
             .map(styleId -> findStyleById(styleType, styleId, findStyleById))
-            .orElse(Result.empty());
+            .orElse(InternalResult.empty());
     }
 
-    private Result<Optional<Style>> findStyleById(
+    private InternalResult<Optional<Style>> findStyleById(
         String styleType,
         String styleId,
         Function<String, Optional<Style>> findStyleById)
     {
         Optional<Style> style = findStyleById.apply(styleId);
         if (style.isPresent()) {
-            return Result.success(style);
+            return InternalResult.success(style);
         } else {
-            return new Result<>(
+            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")));
         }
diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/DocumentReader.java b/src/main/java/org/zwobble/mammoth/internal/docx/DocumentReader.java
index 4341bbf..86a0d1a 100644
--- a/src/main/java/org/zwobble/mammoth/internal/docx/DocumentReader.java
+++ b/src/main/java/org/zwobble/mammoth/internal/docx/DocumentReader.java
@@ -2,7 +2,7 @@ package org.zwobble.mammoth.internal.docx;
 
 import org.zwobble.mammoth.internal.documents.Document;
 import org.zwobble.mammoth.internal.documents.Notes;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.internal.results.InternalResult;
 import org.zwobble.mammoth.internal.util.MammothLists;
 import org.zwobble.mammoth.internal.xml.XmlElement;
 
@@ -21,7 +21,7 @@ public class DocumentReader {
         BodyXmlReader forName(String name);
     }
 
-    public static Result<Document> readDocument(Optional<Path> path, DocxFile zipFile) {
+    public static InternalResult<Document> readDocument(Optional<Path> path, DocxFile zipFile) {
         Styles styles = readStyles(zipFile);
         Numbering numbering = readNumbering(zipFile);
         ContentTypes contentTypes = readContentTypes(zipFile);
@@ -63,14 +63,14 @@ public class DocumentReader {
         }
     }
 
-    private static Result<Notes> readNotes(DocxFile file, BodyReaders bodyReaders) {
-        return Result.map(
+    private static InternalResult<Notes> readNotes(DocxFile file, BodyReaders bodyReaders) {
+        return InternalResult.map(
             tryParseOfficeXml(file, "word/footnotes.xml")
                 .map(NotesXmlReader.footnote(bodyReaders.forName("footnotes"))::readElement)
-                .orElse(Result.success(list())),
+                .orElse(InternalResult.success(list())),
             tryParseOfficeXml(file, "word/endnotes.xml")
                 .map(NotesXmlReader.endnote(bodyReaders.forName("endnotes"))::readElement)
-                .orElse(Result.success(list())),
+                .orElse(InternalResult.success(list())),
             MammothLists::concat).map(Notes::new);
     }
 
diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/DocumentXmlReader.java b/src/main/java/org/zwobble/mammoth/internal/docx/DocumentXmlReader.java
index 3c215fe..be4f474 100644
--- a/src/main/java/org/zwobble/mammoth/internal/docx/DocumentXmlReader.java
+++ b/src/main/java/org/zwobble/mammoth/internal/docx/DocumentXmlReader.java
@@ -2,7 +2,7 @@ package org.zwobble.mammoth.internal.docx;
 
 import org.zwobble.mammoth.internal.documents.Document;
 import org.zwobble.mammoth.internal.documents.Notes;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.internal.results.InternalResult;
 import org.zwobble.mammoth.internal.xml.XmlElement;
 
 public class DocumentXmlReader {
@@ -14,7 +14,7 @@ public class DocumentXmlReader {
         this.notes = notes;
     }
 
-    public Result<Document> readElement(XmlElement element) {
+    public InternalResult<Document> readElement(XmlElement element) {
         XmlElement body = element.findChild("w:body");
         return bodyReader.readElements(body.children())
             .toResult()
diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/NotesXmlReader.java b/src/main/java/org/zwobble/mammoth/internal/docx/NotesXmlReader.java
index 2e31aa2..d2ba221 100644
--- a/src/main/java/org/zwobble/mammoth/internal/docx/NotesXmlReader.java
+++ b/src/main/java/org/zwobble/mammoth/internal/docx/NotesXmlReader.java
@@ -1,7 +1,7 @@
 package org.zwobble.mammoth.internal.docx;
 
 import org.zwobble.mammoth.internal.documents.NoteType;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.internal.results.InternalResult;
 import org.zwobble.mammoth.internal.documents.Note;
 import org.zwobble.mammoth.internal.xml.XmlElement;
 
@@ -29,9 +29,9 @@ public class NotesXmlReader {
         this.noteType = noteType;
     }
 
-    public Result<List<Note>> readElement(XmlElement element) {
+    public InternalResult<List<Note>> readElement(XmlElement element) {
         Iterable<XmlElement> elements = filter(element.findChildren("w:" + tagName), this::isNoteElement);
-        return Result.concat(transform(elements, this::readNoteElement));
+        return InternalResult.concat(transform(elements, this::readNoteElement));
     }
 
     private boolean isNoteElement(XmlElement element) {
@@ -44,7 +44,7 @@ public class NotesXmlReader {
         return type.equals("continuationSeparator") || type.equals("separator");
     }
 
-    private Result<Note> readNoteElement(XmlElement element) {
+    private InternalResult<Note> readNoteElement(XmlElement element) {
         return bodyReader.readElements(element.children())
             .toResult()
             .map(children -> new Note(
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 366fd12..b9e4ec9 100644
--- a/src/main/java/org/zwobble/mammoth/internal/docx/ReadResult.java
+++ b/src/main/java/org/zwobble/mammoth/internal/docx/ReadResult.java
@@ -2,8 +2,8 @@ package org.zwobble.mammoth.internal.docx;
 
 import com.google.common.collect.ImmutableList;
 import org.zwobble.mammoth.internal.documents.DocumentElement;
-import org.zwobble.mammoth.results.Result;
-import org.zwobble.mammoth.results.Warning;
+import org.zwobble.mammoth.internal.results.InternalResult;
+import org.zwobble.mammoth.internal.results.Warning;
 
 import java.util.List;
 import java.util.function.BiFunction;
@@ -27,7 +27,7 @@ public class ReadResult {
     }
 
     public static <T> ReadResult map(
-        Result<T> first,
+        InternalResult<T> first,
         ReadResult second,
         BiFunction<T, List<DocumentElement>, DocumentElement> function)
     {
@@ -78,8 +78,8 @@ public class ReadResult {
         return new ReadResult(concat(elements, extra), list(), warnings);
     }
 
-    public Result<List<DocumentElement>> toResult() {
-        return new Result<>(elements, warnings);
+    public InternalResult<List<DocumentElement>> toResult() {
+        return new InternalResult<>(elements, warnings);
     }
 
     private static <T> List<T> concat(List<T> first, List<T> second) {
diff --git a/src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java b/src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java
new file mode 100644
index 0000000..b3c9ec7
--- /dev/null
+++ b/src/main/java/org/zwobble/mammoth/internal/results/InternalResult.java
@@ -0,0 +1,69 @@
+package org.zwobble.mammoth.internal.results;
+
+import com.google.common.collect.ImmutableList;
+import org.zwobble.mammoth.internal.documents.Style;
+import org.zwobble.mammoth.internal.util.MammothLists;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+
+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();
+        for (InternalResult<T> result : results) {
+            elements.add(result.value);
+            warnings.addAll(result.warnings);
+        }
+        return new InternalResult<>(elements.build(), warnings.build());
+    }
+
+    public static <T1, T2, R> InternalResult<R> map(
+        InternalResult<T1> first,
+        InternalResult<T2> second,
+        BiFunction<T1, T2, R> function)
+    {
+        return new InternalResult<>(
+            function.apply(first.value, second.value),
+            MammothLists.concat(first.warnings, second.warnings));
+    }
+
+    public static InternalResult<Optional<Style>> empty() {
+        return new InternalResult<>(Optional.empty(), list());
+    }
+
+    public static <T> InternalResult<T> success(T value) {
+        return new InternalResult<>(value, list());
+    }
+
+    private final T value;
+    private final List<Warning> warnings;
+
+    public InternalResult(T value, List<Warning> warnings) {
+        this.value = value;
+        this.warnings = warnings;
+    }
+
+    public T getValue() {
+        return value;
+    }
+
+    public List<Warning> getWarnings() {
+        return warnings;
+    }
+
+    public <R> InternalResult<R> map(Function<T, R> function) {
+        return new InternalResult<>(function.apply(value), warnings);
+    }
+
+    public <R> InternalResult<R> flatMap(Function<T, InternalResult<R>> function) {
+        InternalResult<R> intermediateResult = function.apply(value);
+        return new InternalResult<>(
+            intermediateResult.value,
+            MammothLists.concat(warnings, intermediateResult.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
new file mode 100644
index 0000000..062860f
--- /dev/null
+++ b/src/main/java/org/zwobble/mammoth/internal/results/Warning.java
@@ -0,0 +1,16 @@
+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/main/java/org/zwobble/mammoth/results/Result.java b/src/main/java/org/zwobble/mammoth/results/Result.java
deleted file mode 100644
index 063aba4..0000000
--- a/src/main/java/org/zwobble/mammoth/results/Result.java
+++ /dev/null
@@ -1,69 +0,0 @@
-package org.zwobble.mammoth.results;
-
-import com.google.common.collect.ImmutableList;
-import org.zwobble.mammoth.internal.documents.Style;
-import org.zwobble.mammoth.internal.util.MammothLists;
-
-import java.util.List;
-import java.util.Optional;
-import java.util.function.BiFunction;
-import java.util.function.Function;
-
-import static org.zwobble.mammoth.internal.util.MammothLists.list;
-
-public class Result<T> {
-    public static <T> Result<List<T>> concat(Iterable<Result<T>> results) {
-        ImmutableList.Builder<T> elements = ImmutableList.builder();
-        ImmutableList.Builder<Warning> warnings = ImmutableList.builder();
-        for (Result<T> result : results) {
-            elements.add(result.value);
-            warnings.addAll(result.warnings);
-        }
-        return new Result<>(elements.build(), warnings.build());
-    }
-
-    public static <T1, T2, R> Result<R> map(
-        Result<T1> first,
-        Result<T2> second,
-        BiFunction<T1, T2, R> function)
-    {
-        return new Result<>(
-            function.apply(first.value, second.value),
-            MammothLists.concat(first.warnings, second.warnings));
-    }
-
-    public static Result<Optional<Style>> empty() {
-        return new Result<>(Optional.empty(), list());
-    }
-
-    public static <T> Result<T> success(T value) {
-        return new Result<>(value, list());
-    }
-
-    private final T value;
-    private final List<Warning> warnings;
-
-    public Result(T value, List<Warning> warnings) {
-        this.value = value;
-        this.warnings = warnings;
-    }
-
-    public T getValue() {
-        return value;
-    }
-
-    public List<Warning> getWarnings() {
-        return warnings;
-    }
-
-    public <R> Result<R> map(Function<T, R> function) {
-        return new Result<>(function.apply(value), warnings);
-    }
-
-    public <R> Result<R> flatMap(Function<T, Result<R>> function) {
-        Result<R> intermediateResult = function.apply(value);
-        return new Result<>(
-            intermediateResult.value,
-            MammothLists.concat(warnings, intermediateResult.warnings));
-    }
-}
diff --git a/src/main/java/org/zwobble/mammoth/results/Warning.java b/src/main/java/org/zwobble/mammoth/results/Warning.java
deleted file mode 100644
index 25579c2..0000000
--- a/src/main/java/org/zwobble/mammoth/results/Warning.java
+++ /dev/null
@@ -1,16 +0,0 @@
-package org.zwobble.mammoth.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 6a4c036..526c078 100644
--- a/src/test/java/org/zwobble/mammoth/tests/DocumentConverterTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/DocumentConverterTests.java
@@ -6,7 +6,7 @@ import org.zwobble.mammoth.internal.DocumentToHtmlOptions;
 import org.zwobble.mammoth.internal.documents.*;
 import org.zwobble.mammoth.internal.html.Html;
 import org.zwobble.mammoth.internal.html.HtmlNode;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.internal.results.InternalResult;
 import org.zwobble.mammoth.internal.styles.HtmlPath;
 import org.zwobble.mammoth.internal.styles.ParagraphMatcher;
 import org.zwobble.mammoth.internal.styles.RunMatcher;
@@ -21,8 +21,8 @@ import static org.hamcrest.MatcherAssert.assertThat;
 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.results.Result.success;
-import static org.zwobble.mammoth.results.Warning.warning;
+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;
@@ -78,7 +78,7 @@ public class DocumentConverterTests {
             convertToHtmlResult(
                 make(a(PARAGRAPH, with(STYLE, Optional.of(new Style("TipsParagraph", Optional.of("Tips Paragraph"))))))),
 
-            deepEquals(new Result<>(
+            deepEquals(new InternalResult<>(
                 list(Html.element("p")),
                 list(warning("Unrecognised paragraph style: Tips Paragraph (Style ID: TipsParagraph)")))));
     }
@@ -105,7 +105,7 @@ public class DocumentConverterTests {
                     with(STYLE, Optional.of(new Style("TipsRun", Optional.of("Tips Run")))),
                     with(CHILDREN, list(new Text("Hello")))))),
 
-            deepEquals(new Result<>(
+            deepEquals(new InternalResult<>(
                 list(Html.text("Hello")),
                 list(warning("Unrecognised run style: Tips Run (Style ID: TipsRun)")))));
     }
@@ -290,7 +290,7 @@ public class DocumentConverterTests {
     private List<HtmlNode> convertToHtml(Document document) {
         DocumentToHtmlOptions options = DocumentToHtmlOptions.DEFAULT
             .idPrefix("doc-42-");
-        Result<List<HtmlNode>> result = DocumentToHtml.convertToHtml(document, options);
+        InternalResult<List<HtmlNode>> result = DocumentToHtml.convertToHtml(document, options);
         assertThat(result.getWarnings(), hasSize(0));
         return result.getValue();
     }
@@ -300,16 +300,16 @@ public class DocumentConverterTests {
     }
 
     private List<HtmlNode> convertToHtml(DocumentElement element, StyleMap styleMap) {
-        Result<List<HtmlNode>> result = convertToHtmlResult(element, styleMap);
+        InternalResult<List<HtmlNode>> result = convertToHtmlResult(element, styleMap);
         assertThat(result.getWarnings(), hasSize(0));
         return result.getValue();
     }
 
-    private Result<List<HtmlNode>> convertToHtmlResult(DocumentElement element) {
+    private InternalResult<List<HtmlNode>> convertToHtmlResult(DocumentElement element) {
         return convertToHtmlResult(element, StyleMap.EMPTY);
     }
 
-    private Result<List<HtmlNode>> convertToHtmlResult(DocumentElement element, StyleMap styleMap) {
+    private InternalResult<List<HtmlNode>> convertToHtmlResult(DocumentElement element, StyleMap styleMap) {
         DocumentToHtmlOptions options = DocumentToHtmlOptions.DEFAULT
             .idPrefix("doc-42-")
             .addStyleMap(styleMap);
diff --git a/src/test/java/org/zwobble/mammoth/tests/MammothTests.java b/src/test/java/org/zwobble/mammoth/tests/MammothTests.java
index efb95f0..8f44fc9 100644
--- a/src/test/java/org/zwobble/mammoth/tests/MammothTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/MammothTests.java
@@ -2,7 +2,7 @@ package org.zwobble.mammoth.tests;
 
 import org.junit.Test;
 import org.zwobble.mammoth.DocumentConverter;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.Result;
 
 import java.io.File;
 import java.io.IOException;
@@ -12,7 +12,7 @@ import java.util.function.Function;
 
 import static org.hamcrest.Matchers.*;
 import static org.junit.Assert.assertThat;
-import static org.zwobble.mammoth.results.Result.success;
+import static org.zwobble.mammoth.internal.results.InternalResult.success;
 import static org.zwobble.mammoth.tests.DeepReflectionMatcher.deepEquals;
 
 public class MammothTests {
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 a35f248..4c9d621 100644
--- a/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java
@@ -7,8 +7,8 @@ import org.hamcrest.Matchers;
 import org.junit.Test;
 import org.zwobble.mammoth.internal.documents.*;
 import org.zwobble.mammoth.internal.docx.*;
-import org.zwobble.mammoth.results.Result;
-import org.zwobble.mammoth.results.Warning;
+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 +29,7 @@ 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.results.Warning.warning;
+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.*;
@@ -468,7 +468,7 @@ public class BodyXmlTests {
         DocxFile file = InMemoryDocxFile.fromStrings(map("word/media/hat.emf", "Not an image at all!"));
         ContentTypes contentTypes = new ContentTypes(map("emf", "image/x-emf"), map());
 
-        Result<?> result = read(
+        InternalResult<?> result = read(
             a(bodyReader,
                 with(RELATIONSHIPS, relationships),
                 with(DOCX_FILE, file),
@@ -595,18 +595,18 @@ public class BodyXmlTests {
     }
 
     private static DocumentElement readSuccess(Maker<BodyXmlReader> reader, XmlElement element) {
-        Result<DocumentElement> result = read(reader, element);
+        InternalResult<DocumentElement> result = read(reader, element);
         assertThat(result.getWarnings(), deepEquals(list()));
         return result.getValue();
     }
 
-    private static Result<DocumentElement> read(Maker<BodyXmlReader> reader, XmlElement element) {
-        Result<List<DocumentElement>> result = readAll(reader, element);
+    private static InternalResult<DocumentElement> read(Maker<BodyXmlReader> reader, XmlElement element) {
+        InternalResult<List<DocumentElement>> result = readAll(reader, element);
         assertThat(result.getValue(), Matchers.hasSize(1));
         return result.map(elements -> elements.get(0));
     }
 
-    private static Result<List<DocumentElement>> readAll(Maker<BodyXmlReader> reader, XmlElement element) {
+    private static InternalResult<List<DocumentElement>> readAll(Maker<BodyXmlReader> reader, XmlElement element) {
         return reader.make().readElement(element).toResult();
     }
 
@@ -654,7 +654,7 @@ public class BodyXmlTests {
         return hasProperty("numbering", deepEquals(expected));
     }
 
-    private <T> Matcher<Result<? extends T>> isResult(Matcher<T> valueMatcher, List<Warning> warnings) {
+    private <T> Matcher<InternalResult<? extends T>> isResult(Matcher<T> valueMatcher, List<Warning> warnings) {
         return Matchers.allOf(
             hasProperty("value", valueMatcher),
             hasProperty("warnings", deepEquals(warnings)));
diff --git a/src/test/java/org/zwobble/mammoth/tests/docx/DocumentXmlTests.java b/src/test/java/org/zwobble/mammoth/tests/docx/DocumentXmlTests.java
index f2c7dda..dc3e2b7 100644
--- a/src/test/java/org/zwobble/mammoth/tests/docx/DocumentXmlTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/docx/DocumentXmlTests.java
@@ -6,14 +6,14 @@ import org.zwobble.mammoth.internal.documents.Note;
 import org.zwobble.mammoth.internal.documents.NoteType;
 import org.zwobble.mammoth.internal.documents.Notes;
 import org.zwobble.mammoth.internal.docx.DocumentXmlReader;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.internal.results.InternalResult;
 import org.zwobble.mammoth.internal.xml.XmlElement;
 import org.zwobble.mammoth.internal.xml.XmlNodes;
 
 import static com.natpryce.makeiteasy.MakeItEasy.a;
 import static com.natpryce.makeiteasy.MakeItEasy.make;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.zwobble.mammoth.results.Result.success;
+import static org.zwobble.mammoth.internal.results.InternalResult.success;
 import static org.zwobble.mammoth.tests.DeepReflectionMatcher.deepEquals;
 import static org.zwobble.mammoth.tests.documents.DocumentElementMakers.paragraphWithText;
 import static org.zwobble.mammoth.tests.docx.BodyXmlReaderMakers.bodyReader;
@@ -32,7 +32,7 @@ public class DocumentXmlTests {
                             XmlNodes.text("Hello!")))))))))));
 
         DocumentXmlReader reader = new DocumentXmlReader(make(a(bodyReader)), Notes.EMPTY);
-        Result<Document> document = reader.readElement(documentElement);
+        InternalResult<Document> document = reader.readElement(documentElement);
 
         assertThat(
             document,
@@ -48,7 +48,7 @@ public class DocumentXmlTests {
         DocumentXmlReader reader = new DocumentXmlReader(make(a(bodyReader)), notes);
 
         XmlElement documentElement = element("w:document", list(element("w:body")));
-        Result<Document> document = reader.readElement(documentElement);
+        InternalResult<Document> document = reader.readElement(documentElement);
 
         assertThat(
             document.getValue().getNotes().findNote(NoteType.FOOTNOTE, "4").get(),
diff --git a/src/test/java/org/zwobble/mammoth/tests/docx/NotesXmlReaderTests.java b/src/test/java/org/zwobble/mammoth/tests/docx/NotesXmlReaderTests.java
index 05bb4a7..67ec515 100644
--- a/src/test/java/org/zwobble/mammoth/tests/docx/NotesXmlReaderTests.java
+++ b/src/test/java/org/zwobble/mammoth/tests/docx/NotesXmlReaderTests.java
@@ -2,7 +2,7 @@ package org.zwobble.mammoth.tests.docx;
 
 import org.junit.Test;
 import org.zwobble.mammoth.internal.documents.NoteType;
-import org.zwobble.mammoth.results.Result;
+import org.zwobble.mammoth.internal.results.InternalResult;
 import org.zwobble.mammoth.internal.documents.Note;
 import org.zwobble.mammoth.internal.docx.BodyXmlReader;
 import org.zwobble.mammoth.internal.docx.NotesXmlReader;
@@ -13,7 +13,7 @@ import java.util.List;
 import static com.natpryce.makeiteasy.MakeItEasy.a;
 import static com.natpryce.makeiteasy.MakeItEasy.make;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.zwobble.mammoth.results.Result.success;
+import static org.zwobble.mammoth.internal.results.InternalResult.success;
 import static org.zwobble.mammoth.tests.DeepReflectionMatcher.deepEquals;
 import static org.zwobble.mammoth.tests.documents.DocumentElementMakers.PARAGRAPH;
 import static org.zwobble.mammoth.internal.util.MammothLists.list;
@@ -30,7 +30,7 @@ public class NotesXmlReaderTests {
                 element("w:p")))));
 
         NotesXmlReader reader = NotesXmlReader.footnote(bodyReader);
-        Result<List<Note>> notes = reader.readElement(element);
+        InternalResult<List<Note>> notes = reader.readElement(element);
 
         assertThat(
             notes,
@@ -53,7 +53,7 @@ public class NotesXmlReaderTests {
                 element("w:p")))));
 
         NotesXmlReader reader = NotesXmlReader.footnote(bodyReader);
-        Result<List<Note>> notes = reader.readElement(element);
+        InternalResult<List<Note>> notes = reader.readElement(element);
 
         assertThat(notes, deepEquals(success(list())));
     }
-- 
cgit v1.2.3