Redaction

Inheritance: java.lang.Object

public abstract class Redaction

Represents a base abstract class for all redaction types.


Learn more

Constructors

Constructor Description
Redaction()

Methods

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

Redaction()

public Redaction()

getDescription()

public String getDescription()

Returns a string, describing the redaction and its parameters.

Returns: java.lang.String - Text, containing redaction name and parameters.

applyTo(DocumentFormatInstance formatInstance)

public abstract RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)

Applies the redaction to a given format instance.

Parameters:

Parameter Type Description
formatInstance DocumentFormatInstance An instance of a document to apply redaction

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