RedactionPolicy

Inheritance: java.lang.Object

public class RedactionPolicy

Represents a sanitization policy, containing a set of specific redactions to apply.

---

Learn more

• More details about policies: Use of redaction policies
• More details about applying redactions: Redaction basics

Constructors

Constructor	Description
RedactionPolicy()	Creates a new instance of Redaction policy.
RedactionPolicy(Redaction[] redactions)	Creates a new instance of Redaction policy with a specific list of redactions.

Methods

Method	Description
getRedactions()	Gets an array of fully configured Redaction -derived classes.
load(String filePath)	Loads an instance of RedactionPolicy from a file path.
load(InputStream input)	Loads an instance of RedactionPolicy from a stream.
save(String filePath)	Saves the redaction policy to a file.
save(OutputStream output)	Saves the redaction policy to a stream.

RedactionPolicy()

public RedactionPolicy()

Creates a new instance of Redaction policy.

RedactionPolicy(Redaction[] redactions)

public RedactionPolicy(Redaction[] redactions)

Creates a new instance of Redaction policy with a specific list of redactions.

Parameters:

Parameter	Type	Description
redactions	Redaction[]	An array of redactions for the policy

getRedactions()

public final Redaction[] getRedactions()

Gets an array of fully configured Redaction -derived classes.

Returns: com.groupdocs.redaction.Redaction[] - An array of fully configured Redaction -derived classes.

load(String filePath)

public static RedactionPolicy load(String filePath)

Loads an instance of RedactionPolicy from a file path.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	Path to XML file

Returns: RedactionPolicy - Redaction policy

load(InputStream input)

public static RedactionPolicy load(InputStream input)

Loads an instance of RedactionPolicy from a stream.

Parameters:

Parameter	Type	Description
input	java.io.InputStream	Stream containing XML configuration

Returns: RedactionPolicy - Redaction policy

save(String filePath)

public final void save(String filePath)

Saves the redaction policy to a file.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	Path to file.

save(OutputStream output)

public final void save(OutputStream output)

Saves the redaction policy to a stream.

Parameters:

Parameter	Type	Description
output	java.io.OutputStream	Target stream to save the policy