com.groupdocs.redaction

Class Redaction

java.lang.Object

com.groupdocs.redaction.Redaction

Direct Known Subclasses:

AnnotationRedaction, DeleteAnnotationRedaction, ImageAreaRedaction, MetadataRedaction, RemovePageRedaction, TextRedaction

public abstract class Redaction
extends Object

Represents a base abstract class for all redaction types.

Learn more

• More details about redaction types: Redaction basics
• More advanced redaction topics: Advanced usage

Constructor Summary

Constructors

Constructor and Description
Redaction()

Method Summary

Modifier and Type	Method and Description
abstract RedactorLogEntry	applyTo(DocumentFormatInstance formatInstance) Applies the redaction to a given format instance.
String	getDescription() Returns a string, describing the redaction and its parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Redaction

public Redaction()

Method Detail

applyTo

public abstract RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
                                  throws Exception

Applies the redaction to a given format instance.

Parameters:

formatInstance - An instance of a document to apply redaction

Returns:

Status of the redaction: success/failure and error message if any

Throws:

Exception

getDescription

public String getDescription()

Returns a string, describing the redaction and its parameters.

Returns:

Text, containing redaction name and parameters.