com.groupdocs.redaction

Class RedactionPolicy

java.lang.Object

com.groupdocs.redaction.RedactionPolicy

public class RedactionPolicy
extends Object

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

Constructor Summary

Constructors

Constructor and 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.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactionPolicy

public RedactionPolicy()

Creates a new instance of Redaction policy.

RedactionPolicy

public RedactionPolicy(Redaction[] redactions)

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

Parameters:

redactions - An array of redactions for the policy

Method Detail

getRedactions

public final Redaction[] getRedactions()

Gets an array of fully configured Redaction-derived classes.

Returns:

An array of fully configured Redaction-derived classes.

load

public static RedactionPolicy load(InputStream input)
                            throws Exception

Loads an instance of RedactionPolicy from a stream.

Parameters:

input - Stream containing XML configuration

Returns:

Redaction policy

Throws:

Exception

load

public static RedactionPolicy load(String filePath)
                            throws Exception

Loads an instance of RedactionPolicy from a file path.

Parameters:

filePath - Path to XML file

Returns:

Redaction policy

Throws:

Exception

save

public final void save(OutputStream output)
                throws Exception

Saves the redaction policy to a stream.

Parameters:

output - Target stream to save the policy

Throws:

Exception

save

public final void save(String filePath)
                throws Exception

Saves the redaction policy to a file.

Parameters:

filePath - Path to file.

Throws:

Exception