com.groupdocs.redaction.integration

Class DocumentFormatInstance

java.lang.Object

com.groupdocs.redaction.integration.DocumentFormatInstance

public abstract class DocumentFormatInstance
extends Object

Represents a specific format of a document. Implement this class to add your own document types.

Learn more

• More details about implementing custom formats: Create custom format handler

The following example demonstrates how to create an empty stub for a custom format handler.

public class DummyDocument extends DocumentFormatInstance
 {
     {@literal @}Override
     public void load(InputStream output) throws java.lang.Exception
     {
         // load file content
     }
     {@literal @}Override
     public void save(OutputStream output) throws java.lang.Exception
     {
         // save changes to file;
     }
 }
  

Constructor Summary

Constructors

Constructor and Description
DocumentFormatInstance()

Method Summary

Modifier and Type	Method and Description
static DocumentFormatInstance	createInstance(Class docType)
static RedactorConfiguration	getDefaultConfiguration() Provides a singleton instance with default configuration of built-in formats.
String	getPassword() Gets a password for password protected documents.
boolean	getRequiresRasterization() Gets value, indicating if the format instance is read-only and cannot be saved in original format.
void	initialize(DocumentFormatConfiguration config, RedactorSettings settings) Performs initialization of the instance of document format handler.
boolean	isAccessGranted()
boolean	isRedactionAccepted(RedactionDescription description) Checks for IRedactionCallback implementation and invokes it, if specified.
void	load(InputStream input) Loads the document from a stream.
boolean	performBinaryCheck(InputStream input) Checks if the given stream contains a document, supported by this format instance.
abstract void	save(OutputStream output) Saves the document to a stream.
protected void	setAccessGranted(boolean isGranted) Sets a validation status, if the document requires password.
void	setPassword(String value) Sets a password for password protected documents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentFormatInstance

public DocumentFormatInstance()

Method Detail

createInstance

public static DocumentFormatInstance createInstance(Class docType)
                                             throws Exception

Throws:

Exception

getDefaultConfiguration

public static RedactorConfiguration getDefaultConfiguration()

Provides a singleton instance with default configuration of built-in formats.

Returns:

Configuration instance

getPassword

public final String getPassword()

Gets a password for password protected documents.

Returns:

A password for password protected documents.

getRequiresRasterization

public boolean getRequiresRasterization()

Gets value, indicating if the format instance is read-only and cannot be saved in original format.

Returns:

Value, indicating if the format instance is read-only and cannot be saved in original format.

initialize

public void initialize(DocumentFormatConfiguration config,
                       RedactorSettings settings)

Performs initialization of the instance of document format handler.

Parameters:

config - Format configuration

settings - Default settings for redaction process.

isAccessGranted

public final boolean isAccessGranted()

isRedactionAccepted

public final boolean isRedactionAccepted(RedactionDescription description)

Checks for IRedactionCallback implementation and invokes it, if specified.

Parameters:

description - Redaction description

Returns:

True (by default) if redaction is accepted

load

public void load(InputStream input)
          throws Exception

Loads the document from a stream.

Parameters:

input - Stream to read from

Throws:

Exception

performBinaryCheck

public boolean performBinaryCheck(InputStream input)
                           throws Exception

Checks if the given stream contains a document, supported by this format instance.

Parameters:

input - Document content stream

Returns:

True, if the document can be loaded by this format instance and false otherwise

Throws:

Exception

save

public abstract void save(OutputStream output)
                   throws Exception

Saves the document to a stream.

Parameters:

output - Target stream to save the document

Throws:

java.lang.Exception;

Exception

setAccessGranted

protected final void setAccessGranted(boolean isGranted)

Sets a validation status, if the document requires password.

Parameters:

isGranted - True, if password is correct

setPassword

public final void setPassword(String value)

Sets a password for password protected documents.

Parameters:

value - A password for password protected documents.