Document (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- com.groupdocs.comparison.Document

All Implemented Interfaces:: Closeable, AutoCloseable

public class Document
extends Object
implements Closeable

Represents a document for comparison process.

The Document class provides methods to load, generate preview images, and manipulate documents during the comparison process.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
     try (IDocumentInfo info = comparer.getSource().getDocumentInfo()) {
         System.out.println("File type: " + info.getFileType());
         System.out.println("Number of pages: " + info.getPageCount());
         System.out.println("Document size: " + info.getSize());
     }
 }

See Also:: Comparer, IDocumentInfo

Constructor Summary

Constructors
Constructor and Description
`Document(InputStream stream)` Initializes new instance of Document class with the specified document stream.
`Document(InputStream inputStream, LoadOptions loadOptions)` Initializes new instance of Document class with the specified document stream and load options.
`Document(InputStream stream, String password)` Initializes new instance of Document class with the specified document stream and a password.
`Document(Path filePath)` Initializes new instance of Document class with the specified document path.
`Document(Path filePath, LoadOptions loadOptions)` Initializes new instance of Document class with the specified document path and load options.
`Document(Path filePath, String password)` Initializes new instance of Document class with the specified document path and a password.
`Document(String filePath)` Initializes new instance of Document class with the specified document path.
`Document(String filePathOrTextContent, boolean isLoadText)` Initializes new instance of Document class with the specified document path or text content and a flag that indicates what was passed.
`Document(String filePath, LoadOptions loadOptions)` Initializes new instance of Document class with the specified document path and load options.
`Document(String filePath, String password)` Initializes new instance of Document class with the specified document path and a password.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`InputStream`	`createStream()` Creates new stream with document content.
`void`	`generatePreview(PreviewOptions previewOptions)` Generates document previews based on the provided `PreviewOptions`.
`List<ChangeInfo>`	`getChanges()` Gets a list of `ChangeInfo` objects representing the changes detected during the comparison process.
`IDocumentInfo`	`getDocumentInfo()` Gets information about the document, including document type, page count, page sizes, and more.
`FileType`	`getFileType()` Gets the type of the document.
`String`	`getName()` Gets the name of the document.
`String`	`getPassword()` Gets the password of the document
`long`	`getStreamLength()` Gets the size of the document
`void`	`setChanges(List<ChangeInfo> value)` Sets a list of `ChangeInfo` objects representing the changes detected during the comparison process.
`void`	`setFileType(FileType fileType)` Sets the type of the document.
`void`	`setName(String value)` Sets the name of the document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Document
```
public Document(InputStream stream)
```
    Initializes new instance of Document class with the specified document stream.
    
    Parameters:
    
    stream - Document stream
  - Document
```
public Document(InputStream inputStream,
                LoadOptions loadOptions)
```
    Initializes new instance of Document class with the specified document stream and load options.
    
    Parameters:
    
    inputStream - Document stream
    
    loadOptions - Load options
  - Document
```
public Document(InputStream stream,
                String password)
```
    Initializes new instance of Document class with the specified document stream and a password.
    
    Parameters:
    
    stream - Document stream
    
    password - Document password
  - Document
```
public Document(Path filePath)
```
    Initializes new instance of Document class with the specified document path.
    
    Parameters:
    
    filePath - Document path
  - Document
```
public Document(Path filePath,
                LoadOptions loadOptions)
```
    Initializes new instance of Document class with the specified document path and load options.
    
    Parameters:
    
    filePath - Document path
    
    loadOptions - Load options
  - Document
```
public Document(Path filePath,
                String password)
```
    Initializes new instance of Document class with the specified document path and a password.
    
    Parameters:
    
    filePath - Document path
    
    password - Document password
  - Document
```
public Document(String filePath)
```
    Initializes new instance of Document class with the specified document path.
    
    Parameters:
    
    filePath - Document path
  - Document
```
public Document(String filePathOrTextContent,
                boolean isLoadText)
```
    Initializes new instance of Document class with the specified document path or text content and a flag that indicates what was passed.
    
    Parameters:
    
    filePathOrTextContent - the file path
    
    isLoadText - the is load text
  - Document
```
public Document(String filePath,
                LoadOptions loadOptions)
```
    Initializes new instance of Document class with the specified document path and load options.
    
    Parameters:
    
    filePath - Document path
    
    loadOptions - Load options
  - Document
```
public Document(String filePath,
                String password)
```
    Initializes new instance of Document class with the specified document path and a password.
    
    Parameters:
    
    filePath - Document path
    
    password - Document password
- Method Detail
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - createStream
```
public InputStream createStream()
```
    Creates new stream with document content.
    
    Returns:
    
    the stream with document content
  - generatePreview
```
public final void generatePreview(PreviewOptions previewOptions)
```
    Generates document previews based on the provided PreviewOptions.
    This method generates previews of the document pages according to the specified options, such as preview format, page numbers, and output stream provider. The generated previews can be saved or further processed as needed.
    - Learn more about how to generate previews for document pages: How to generate document pages preview using GroupDocs.Comparison
    Example usage:
```
 try (Comparer comparer = new Comparer(sourceFile)) {
     PreviewOptions previewOptions = new PreviewOptions(
             pageNumber -> Files.newOutputStream(Paths.get("preview-image-page-" + pageNumber + ".png"))
     );
     previewOptions.setPreviewFormat(PreviewFormats.PNG);
     previewOptions.setPageNumbers(new int[]{1, 2});
     comparer.getSource().generatePreview(previewOptions);
 }
 
```
    Parameters:
    
    previewOptions - The preview options specifying the format, page numbers and so on
    
    See Also:
    
    Comparer, PreviewOptions
  - getChanges
```
public final List<ChangeInfo> getChanges()
```
    Gets a list of ChangeInfo objects representing the changes detected during the comparison process.
    
    Use this method to get detailed information about the changes between the source document and the target document(s). Each ChangeInfo object contains information such as the type of change, the affected area, and the content before and after the change.
    
    Returns:
    
    a list of ChangeInfo objects representing the changes detected during the comparison process
    
    See Also:
    
    ChangeInfo
  - getDocumentInfo
```
public final IDocumentInfo getDocumentInfo()
```
    Gets information about the document, including document type, page count, page sizes, and more.
    - Learn more about document file type, page count, size, and other format-specific properties: How to get document info using GroupDocs.Comparison
    Returns:
    
    the document information
    
    See Also:
    
    IDocumentInfo
  - getFileType
```
public FileType getFileType()
```
    Gets the type of the document.
    
    Returns:
    
    the type of the document
  - getName
```
public final String getName()
```
    Gets the name of the document.
    
    Returns:
    
    the name of the document
  - getPassword
```
public String getPassword()
```
    Gets the password of the document
    
    Returns:
    
    the password of the document
  - getStreamLength
```
public long getStreamLength()
```
    Gets the size of the document
    
    Returns:
    
    the size of the document
  - setChanges
```
public final void setChanges(List<ChangeInfo> value)
```
    Sets a list of ChangeInfo objects representing the changes detected during the comparison process.
    
    Use this method to get detailed information about the changes between the source document and the target document(s). Each ChangeInfo object contains information such as the type of change, the affected area, and the content before and after the change.
    
    Parameters:
    
    value - a list of ChangeInfo objects representing the changes detected during the comparison process
    
    See Also:
    
    ChangeInfo
  - setFileType
```
public void setFileType(FileType fileType)
```
    Sets the type of the document.
    
    Parameters:
    
    fileType - the type of the document
  - setName
```
public final void setName(String value)
```
    Sets the name of the document.
    
    Parameters:
    
    value - the name of the document

Class Document

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Method Detail

close

createStream

generatePreview

getChanges

getDocumentInfo

getFileType

getName

getPassword

getStreamLength

setChanges

setFileType

setName