com.groupdocs.redaction.redactions

Class RegexRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.TextRedaction

com.groupdocs.redaction.redactions.RegexRedaction

Direct Known Subclasses:

PageAreaRedaction

public class RegexRedaction
extends TextRedaction

Represents a text redaction that searches and replaces text in the document by matching provided regular expression.

Learn more

• More details about applying redactions: Redaction basics
• More details about document text redactions: Text redactions

Constructor Summary

Constructors

Constructor and Description
RegexRedaction(Pattern regex, ReplacementOptions options) Initializes a new instance of RegexRedaction class.
RegexRedaction(String pattern, ReplacementOptions options) Initializes a new instance of RegexRedaction 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	getRegularExpression() Gets the regular expression to match.

Methods inherited from class com.groupdocs.redaction.redactions.TextRedaction

getActionOptions, getOcrConnector, processAsTextual, setOcrConnector

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexRedaction

public RegexRedaction(Pattern regex,
                      ReplacementOptions options)

Initializes a new instance of RegexRedaction class.

Parameters:

regex - Regular expression to search and replace

options - Replacement options (textual, color)

RegexRedaction

public RegexRedaction(String pattern,
                      ReplacementOptions options)

Initializes a new instance of RegexRedaction class.

Parameters:

pattern - Regular expression to search and replace

options - Replacement options (textual, color)

Method Detail

applyTo

public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
                         throws Exception

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

Throws:

Exception

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.

getRegularExpression

public final Pattern getRegularExpression()

Gets the regular expression to match.

Returns:

The regular expression to match.