Interface OfficeDocument
-
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
XDOMOfficeDocument
,XHTMLOfficeDocument
public interface OfficeDocument extends Closeable
Represents an office document being imported.- Since:
- 2.1M1
- Version:
- $Id: 758e8633997aa2bf7ae934f760e50d415fb583df $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
close()
default Set<File>
getArtifactsFiles()
Returns the files corresponding to all the artifacts for this office document, except the conversion of the document itself.String
getContentAsString()
Returns the content of this document as a string.Object
getContentDocument()
Returns the content of this office document.default OfficeConverterResult
getConverterResult()
-
-
-
Method Detail
-
getContentDocument
Object getContentDocument()
Returns the content of this office document. Content document type may vary depending on the implementation. For an example, a particular implementation might return an html DOM object while another implementation might return an XDOM.- Returns:
- content of this document.
-
getContentAsString
String getContentAsString()
Returns the content of this document as a string.- Returns:
- content of this document as a string.
-
getArtifactsFiles
@Unstable default Set<File> getArtifactsFiles()
Returns the files corresponding to all the artifacts for this office document, except the conversion of the document itself. Artifacts are generated during the import operation if the original office document contains embedded non-textual elements. Also, some office formats (like presentations) result in multiple output files when converted into html. In this case all these output files will be considered as artifacts.- Returns:
- the set of artifacts related to this office document.
- Since:
- 13.1RC1
-
getConverterResult
@Unstable default OfficeConverterResult getConverterResult()
- Returns:
- the converter result.
- Since:
- 13.1RC1
-
close
default void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
-