From 5d244e294bf0fc420cca8ed8bf481b7353d459d5 Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Sun, 13 Nov 2016 19:39:25 +0000 Subject: Rename DocxFile to Archive --- .../internal/InternalDocumentConverter.java | 20 ++++----- .../org/zwobble/mammoth/internal/docx/Archive.java | 10 +++++ .../mammoth/internal/docx/BodyXmlReader.java | 4 +- .../mammoth/internal/docx/DocumentReader.java | 18 ++++----- .../zwobble/mammoth/internal/docx/DocxFile.java | 10 ----- .../zwobble/mammoth/internal/docx/DocxFiles.java | 2 +- .../mammoth/internal/docx/EmbeddedStyleMap.java | 2 +- .../mammoth/internal/docx/InMemoryArchive.java | 47 ++++++++++++++++++++++ .../mammoth/internal/docx/InMemoryDocxFile.java | 47 ---------------------- .../mammoth/internal/docx/ZippedArchive.java | 35 ++++++++++++++++ .../mammoth/internal/docx/ZippedDocxFile.java | 35 ---------------- 11 files changed, 115 insertions(+), 115 deletions(-) create mode 100644 src/main/java/org/zwobble/mammoth/internal/docx/Archive.java delete mode 100644 src/main/java/org/zwobble/mammoth/internal/docx/DocxFile.java create mode 100644 src/main/java/org/zwobble/mammoth/internal/docx/InMemoryArchive.java delete mode 100644 src/main/java/org/zwobble/mammoth/internal/docx/InMemoryDocxFile.java create mode 100644 src/main/java/org/zwobble/mammoth/internal/docx/ZippedArchive.java delete mode 100644 src/main/java/org/zwobble/mammoth/internal/docx/ZippedDocxFile.java (limited to 'src/main') diff --git a/src/main/java/org/zwobble/mammoth/internal/InternalDocumentConverter.java b/src/main/java/org/zwobble/mammoth/internal/InternalDocumentConverter.java index 3966b51..c5ba826 100644 --- a/src/main/java/org/zwobble/mammoth/internal/InternalDocumentConverter.java +++ b/src/main/java/org/zwobble/mammoth/internal/InternalDocumentConverter.java @@ -6,10 +6,10 @@ import org.zwobble.mammoth.internal.documents.DocumentElement; import org.zwobble.mammoth.internal.documents.HasChildren; import org.zwobble.mammoth.internal.documents.Paragraph; import org.zwobble.mammoth.internal.documents.Text; -import org.zwobble.mammoth.internal.docx.DocxFile; +import org.zwobble.mammoth.internal.docx.Archive; import org.zwobble.mammoth.internal.docx.EmbeddedStyleMap; -import org.zwobble.mammoth.internal.docx.InMemoryDocxFile; -import org.zwobble.mammoth.internal.docx.ZippedDocxFile; +import org.zwobble.mammoth.internal.docx.InMemoryArchive; +import org.zwobble.mammoth.internal.docx.ZippedArchive; import org.zwobble.mammoth.internal.html.Html; import org.zwobble.mammoth.internal.results.InternalResult; import org.zwobble.mammoth.internal.styles.StyleMap; @@ -48,7 +48,7 @@ public class InternalDocumentConverter { convertToHtml(Optional.of(file.toPath()), zipFile))); } - private InternalResult convertToHtml(Optional path, DocxFile zipFile) { + private InternalResult convertToHtml(Optional path, Archive zipFile) { Optional styleMap = readEmbeddedStyleMap(zipFile).map(StyleMapParser::parse); DocumentToHtmlOptions conversionOptions = styleMap.map(options::addEmbeddedStyleMap).orElse(options); @@ -59,7 +59,7 @@ public class InternalDocumentConverter { .map(Html::write); } - private Optional readEmbeddedStyleMap(DocxFile zipFile) { + private Optional readEmbeddedStyleMap(Archive zipFile) { return PassThroughException.wrap(() -> EmbeddedStyleMap.readStyleMap(zipFile)); } @@ -75,19 +75,19 @@ public class InternalDocumentConverter { extractRawText(Optional.of(file.toPath()), zipFile))); } - private InternalResult extractRawText(Optional path, DocxFile zipFile) { + private InternalResult extractRawText(Optional path, Archive zipFile) { return readDocument(path, zipFile) .map(InternalDocumentConverter::extractRawTextOfChildren); } - private static T withDocxFile(File file, Function function) throws IOException { - try (DocxFile zipFile = new ZippedDocxFile(file)) { + private static T withDocxFile(File file, Function function) throws IOException { + try (Archive zipFile = new ZippedArchive(file)) { return function.apply(zipFile); } } - private static T withDocxFile(InputStream stream, Function function) throws IOException { - try (DocxFile zipFile = InMemoryDocxFile.fromStream(stream)) { + private static T withDocxFile(InputStream stream, Function function) throws IOException { + try (Archive zipFile = InMemoryArchive.fromStream(stream)) { return function.apply(zipFile); } } diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/Archive.java b/src/main/java/org/zwobble/mammoth/internal/docx/Archive.java new file mode 100644 index 0000000..8354662 --- /dev/null +++ b/src/main/java/org/zwobble/mammoth/internal/docx/Archive.java @@ -0,0 +1,10 @@ +package org.zwobble.mammoth.internal.docx; + +import java.io.Closeable; +import java.io.IOException; +import java.io.InputStream; +import java.util.Optional; + +public interface Archive extends Closeable { + Optional tryGetInputStream(String name) throws IOException; +} 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 fdbeee1..f31f6ee 100644 --- a/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java +++ b/src/main/java/org/zwobble/mammoth/internal/docx/BodyXmlReader.java @@ -31,7 +31,7 @@ public class BodyXmlReader { private final Numbering numbering; private final Relationships relationships; private final ContentTypes contentTypes; - private final DocxFile file; + private final Archive file; private final FileReader fileReader; public BodyXmlReader( @@ -39,7 +39,7 @@ public class BodyXmlReader { Numbering numbering, Relationships relationships, ContentTypes contentTypes, - DocxFile file, + Archive file, FileReader fileReader) { this.styles = styles; 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 0452c63..afb7b74 100644 --- a/src/main/java/org/zwobble/mammoth/internal/docx/DocumentReader.java +++ b/src/main/java/org/zwobble/mammoth/internal/docx/DocumentReader.java @@ -21,7 +21,7 @@ public class DocumentReader { BodyXmlReader forName(String name); } - public static InternalResult readDocument(Optional path, DocxFile zipFile) { + public static InternalResult readDocument(Optional path, Archive zipFile) { Styles styles = readStyles(zipFile); Numbering numbering = readNumbering(zipFile); ContentTypes contentTypes = readContentTypes(zipFile); @@ -39,13 +39,13 @@ public class DocumentReader { }); } - private static InternalResult> readComments(DocxFile file, BodyReaders bodyReaders) { + private static InternalResult> readComments(Archive file, BodyReaders bodyReaders) { return tryParseOfficeXml(file, "word/comments.xml") .map(new CommentXmlReader(bodyReaders.forName("comments"))::readElement) .orElse(InternalResult.success(list())); } - private static InternalResult readNotes(DocxFile file, BodyReaders bodyReaders) { + private static InternalResult readNotes(Archive file, BodyReaders bodyReaders) { return InternalResult.map( tryParseOfficeXml(file, "word/footnotes.xml") .map(NotesXmlReader.footnote(bodyReaders.forName("footnotes"))::readElement) @@ -56,36 +56,36 @@ public class DocumentReader { Lists::eagerConcat).map(Notes::new); } - private static Styles readStyles(DocxFile file) { + private static Styles readStyles(Archive file) { return tryParseOfficeXml(file, "word/styles.xml") .map(StylesXml::readStylesXmlElement) .orElse(Styles.EMPTY); } - private static Numbering readNumbering(DocxFile file) { + private static Numbering readNumbering(Archive file) { return tryParseOfficeXml(file, "word/numbering.xml") .map(NumberingXml::readNumberingXmlElement) .orElse(Numbering.EMPTY); } - private static ContentTypes readContentTypes(DocxFile file) { + private static ContentTypes readContentTypes(Archive file) { return tryParseOfficeXml(file, "[Content_Types].xml") .map(ContentTypesXml::readContentTypesXmlElement) .orElse(ContentTypes.DEFAULT); } - private static Relationships readRelationships(DocxFile zipFile, String name) { + private static Relationships readRelationships(Archive zipFile, String name) { return tryParseOfficeXml(zipFile, "word/_rels/" + name + ".xml.rels") .map(RelationshipsXml::readRelationshipsXmlElement) .orElse(Relationships.EMPTY); } - private static Optional tryParseOfficeXml(DocxFile zipFile, String name) { + private static Optional tryParseOfficeXml(Archive zipFile, String name) { return PassThroughException.wrap(() -> zipFile.tryGetInputStream(name).map(OfficeXml::parseXml)); } - private static XmlElement parseOfficeXml(DocxFile zipFile, String name) { + private static XmlElement parseOfficeXml(Archive zipFile, String name) { return tryParseOfficeXml(zipFile, name) .orElseThrow(() -> new PassThroughException(new IOException("Missing entry in file: " + name))); } diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/DocxFile.java b/src/main/java/org/zwobble/mammoth/internal/docx/DocxFile.java deleted file mode 100644 index 23bddb1..0000000 --- a/src/main/java/org/zwobble/mammoth/internal/docx/DocxFile.java +++ /dev/null @@ -1,10 +0,0 @@ -package org.zwobble.mammoth.internal.docx; - -import java.io.Closeable; -import java.io.IOException; -import java.io.InputStream; -import java.util.Optional; - -public interface DocxFile extends Closeable { - Optional tryGetInputStream(String name) throws IOException; -} diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/DocxFiles.java b/src/main/java/org/zwobble/mammoth/internal/docx/DocxFiles.java index 5d06b76..1860bb7 100644 --- a/src/main/java/org/zwobble/mammoth/internal/docx/DocxFiles.java +++ b/src/main/java/org/zwobble/mammoth/internal/docx/DocxFiles.java @@ -4,7 +4,7 @@ import java.io.IOException; import java.io.InputStream; public class DocxFiles { - static InputStream getInputStream(DocxFile file, String name) throws IOException { + static InputStream getInputStream(Archive file, String name) throws IOException { return file.tryGetInputStream(name) .orElseThrow(() -> new IOException("Missing entry in file: " + name)); } diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/EmbeddedStyleMap.java b/src/main/java/org/zwobble/mammoth/internal/docx/EmbeddedStyleMap.java index 306ae99..2befa20 100644 --- a/src/main/java/org/zwobble/mammoth/internal/docx/EmbeddedStyleMap.java +++ b/src/main/java/org/zwobble/mammoth/internal/docx/EmbeddedStyleMap.java @@ -10,7 +10,7 @@ import java.util.stream.Collectors; public class EmbeddedStyleMap { private static final String PATH = "mammoth/style-map"; - public static Optional readStyleMap(DocxFile file) throws IOException { + public static Optional readStyleMap(Archive file) throws IOException { return file.tryGetInputStream(PATH) .map(inputStream -> readInputStream(inputStream)); } diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/InMemoryArchive.java b/src/main/java/org/zwobble/mammoth/internal/docx/InMemoryArchive.java new file mode 100644 index 0000000..fa635c1 --- /dev/null +++ b/src/main/java/org/zwobble/mammoth/internal/docx/InMemoryArchive.java @@ -0,0 +1,47 @@ +package org.zwobble.mammoth.internal.docx; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.zip.ZipEntry; +import java.util.zip.ZipInputStream; + +import static org.zwobble.mammoth.internal.util.Maps.eagerMapValues; +import static org.zwobble.mammoth.internal.util.Maps.lookup; +import static org.zwobble.mammoth.internal.util.Streams.toByteArray; + +public class InMemoryArchive implements Archive { + public static Archive fromStream(InputStream stream) throws IOException { + ZipInputStream zipStream = new ZipInputStream(stream); + Map entries = new HashMap<>(); + ZipEntry entry; + while ((entry = zipStream.getNextEntry()) != null) { + entries.put(entry.getName(), toByteArray(zipStream)); + } + return new InMemoryArchive(entries); + } + + public static Archive fromStrings(Map entries) { + return new InMemoryArchive(eagerMapValues(entries, value -> value.getBytes(StandardCharsets.UTF_8))); + } + + private final Map entries; + + public InMemoryArchive(Map entries) { + this.entries = entries; + } + + @Override + public Optional tryGetInputStream(String name) throws IOException { + return lookup(entries, name) + .map(ByteArrayInputStream::new); + } + + @Override + public void close() throws IOException { + } +} diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/InMemoryDocxFile.java b/src/main/java/org/zwobble/mammoth/internal/docx/InMemoryDocxFile.java deleted file mode 100644 index c4ef2c3..0000000 --- a/src/main/java/org/zwobble/mammoth/internal/docx/InMemoryDocxFile.java +++ /dev/null @@ -1,47 +0,0 @@ -package org.zwobble.mammoth.internal.docx; - -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.nio.charset.StandardCharsets; -import java.util.HashMap; -import java.util.Map; -import java.util.Optional; -import java.util.zip.ZipEntry; -import java.util.zip.ZipInputStream; - -import static org.zwobble.mammoth.internal.util.Maps.eagerMapValues; -import static org.zwobble.mammoth.internal.util.Maps.lookup; -import static org.zwobble.mammoth.internal.util.Streams.toByteArray; - -public class InMemoryDocxFile implements DocxFile { - public static DocxFile fromStream(InputStream stream) throws IOException { - ZipInputStream zipStream = new ZipInputStream(stream); - Map entries = new HashMap<>(); - ZipEntry entry; - while ((entry = zipStream.getNextEntry()) != null) { - entries.put(entry.getName(), toByteArray(zipStream)); - } - return new InMemoryDocxFile(entries); - } - - public static DocxFile fromStrings(Map entries) { - return new InMemoryDocxFile(eagerMapValues(entries, value -> value.getBytes(StandardCharsets.UTF_8))); - } - - private final Map entries; - - public InMemoryDocxFile(Map entries) { - this.entries = entries; - } - - @Override - public Optional tryGetInputStream(String name) throws IOException { - return lookup(entries, name) - .map(ByteArrayInputStream::new); - } - - @Override - public void close() throws IOException { - } -} diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/ZippedArchive.java b/src/main/java/org/zwobble/mammoth/internal/docx/ZippedArchive.java new file mode 100644 index 0000000..27e7fa4 --- /dev/null +++ b/src/main/java/org/zwobble/mammoth/internal/docx/ZippedArchive.java @@ -0,0 +1,35 @@ +package org.zwobble.mammoth.internal.docx; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.util.Optional; +import java.util.zip.ZipEntry; +import java.util.zip.ZipFile; + +public class ZippedArchive implements Archive { + private final ZipFile zipFile; + + public ZippedArchive(ZipFile zipFile) { + this.zipFile = zipFile; + } + + public ZippedArchive(File file) throws IOException { + this(new ZipFile(file)); + } + + @Override + public Optional tryGetInputStream(String name) throws IOException { + ZipEntry entry = zipFile.getEntry(name); + if (entry == null) { + return Optional.empty(); + } else { + return Optional.of(zipFile.getInputStream(entry)); + } + } + + @Override + public void close() throws IOException { + zipFile.close(); + } +} diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/ZippedDocxFile.java b/src/main/java/org/zwobble/mammoth/internal/docx/ZippedDocxFile.java deleted file mode 100644 index 559be1b..0000000 --- a/src/main/java/org/zwobble/mammoth/internal/docx/ZippedDocxFile.java +++ /dev/null @@ -1,35 +0,0 @@ -package org.zwobble.mammoth.internal.docx; - -import java.io.File; -import java.io.IOException; -import java.io.InputStream; -import java.util.Optional; -import java.util.zip.ZipEntry; -import java.util.zip.ZipFile; - -public class ZippedDocxFile implements DocxFile { - private final ZipFile zipFile; - - public ZippedDocxFile(ZipFile zipFile) { - this.zipFile = zipFile; - } - - public ZippedDocxFile(File file) throws IOException { - this(new ZipFile(file)); - } - - @Override - public Optional tryGetInputStream(String name) throws IOException { - ZipEntry entry = zipFile.getEntry(name); - if (entry == null) { - return Optional.empty(); - } else { - return Optional.of(zipFile.getInputStream(entry)); - } - } - - @Override - public void close() throws IOException { - zipFile.close(); - } -} -- cgit v1.2.3