com.groupdocs.redaction.redactions

Class AnnotationRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.AnnotationRedaction

public class AnnotationRedaction
extends Redaction

Represents a redaction that replaces annotation text (comments, etc.) matching a given regular expression.

Learn more

• More details about applying redactions: Redaction basics
• More details about document annotation redactions: Annotation redactions

The following example demonstrates how to replace the name "John" with "[redacted]" in all annotations.

try (Redactor redactor = new Redactor("C:\\test.pdf"))
 {
    redactor.apply(new AnnotationRedaction("(?im:john)", "[redacted]"));
    redactor.save()
 }
  

Constructor Summary

Constructors

Constructor and Description
AnnotationRedaction(Pattern regex, String replacement) Initializes a new instance of AnnotationRedaction class.
AnnotationRedaction(String pattern, String replacement) Initializes a new instance of AnnotationRedaction class.

Method Summary

Modifier and Type	Method and Description
RedactorLogEntry	applyTo(DocumentFormatInstance formatInstance) Applies the redaction to a given format instance.
String	getDescription() Returns a string, describing the redaction and its parameters.
Pattern	getExpression() Gets the regular expression to match.
String	getReplacement() Gets a textual replacement for matched text.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationRedaction

public AnnotationRedaction(Pattern regex,
                           String replacement)

Initializes a new instance of AnnotationRedaction class.

Parameters:

regex - Regular expression to match

replacement - Textual replacement for matched text

AnnotationRedaction

public AnnotationRedaction(String pattern,
                           String replacement)

Initializes a new instance of AnnotationRedaction class.

Parameters:

pattern - Regular expression to match

replacement - Textual replacement for matched text

Method Detail

applyTo

public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)

Applies the redaction to a given format instance.

Specified by:

applyTo in class Redaction

Parameters:

formatInstance - An instance of a document to apply redaction

Returns:

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

getDescription

public String getDescription()

Returns a string, describing the redaction and its parameters.

Overrides:

getDescription in class Redaction

Returns:

Text, containing redaction name and parameters.

getExpression

public final Pattern getExpression()

Gets the regular expression to match.

Returns:

The regular expression to match.

getReplacement

public final String getReplacement()

Gets a textual replacement for matched text.

Returns:

A textual replacement for matched text.