Package net.webpdf.wsclient.openapi

Class OperationBlacken

java.lang.Object

net.webpdf.wsclient.openapi.OperationBlacken

public class OperationBlacken
extends Object

If this element is set, all redact annotations placed in the document will be converted into actual content redactions. Content obscured by such an annotation will be irretrievably removed from the page content.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_COLLISION_RATIO
static String	JSON_PROPERTY_REDACT_ANNOTATIONS
static String	JSON_PROPERTY_REDACT_IMAGES
static String	JSON_PROPERTY_REDACT_PATHS
static String	JSON_PROPERTY_REDACT_TEXTS

Constructor Summary

Constructors

Constructor	Description
OperationBlacken()

Method Summary

Modifier and Type	Method	Description
OperationBlacken	collisionRatio(Integer collisionRatio)
boolean	equals(Object o)
@Nullable Integer	getCollisionRatio()	Specifies a percentage value by which a letter must be obscured at least to be considered blackened and thus removed.
@Nullable Boolean	getRedactAnnotations()	If this value is set to \"true\", all blackened annotations will be removed.
@Nullable Boolean	getRedactImages()	If this value is set to true, all blackened image data will be removed.
@Nullable Boolean	getRedactPaths()	If this value is set to true, all blackened character paths are removed.
@Nullable Boolean	getRedactTexts()	If this value is set to \"true\", all texts are blackened letter by letter.
int	hashCode()
OperationBlacken	redactAnnotations(Boolean redactAnnotations)
OperationBlacken	redactImages(Boolean redactImages)
OperationBlacken	redactPaths(Boolean redactPaths)
OperationBlacken	redactTexts(Boolean redactTexts)
void	setCollisionRatio(Integer collisionRatio)
void	setRedactAnnotations(Boolean redactAnnotations)
void	setRedactImages(Boolean redactImages)
void	setRedactPaths(Boolean redactPaths)
void	setRedactTexts(Boolean redactTexts)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_COLLISION_RATIO

public static final String JSON_PROPERTY_COLLISION_RATIO

See Also:

Constant Field Values

JSON_PROPERTY_REDACT_ANNOTATIONS

public static final String JSON_PROPERTY_REDACT_ANNOTATIONS

See Also:

Constant Field Values

JSON_PROPERTY_REDACT_IMAGES

public static final String JSON_PROPERTY_REDACT_IMAGES

See Also:

Constant Field Values

JSON_PROPERTY_REDACT_PATHS

public static final String JSON_PROPERTY_REDACT_PATHS

See Also:

Constant Field Values

JSON_PROPERTY_REDACT_TEXTS

public static final String JSON_PROPERTY_REDACT_TEXTS

See Also:

Constant Field Values

Constructor Detail

OperationBlacken

public OperationBlacken()

Method Detail

collisionRatio

public OperationBlacken collisionRatio(Integer collisionRatio)

getCollisionRatio

@Nullable
public @Nullable Integer getCollisionRatio()

Specifies a percentage value by which a letter must be obscured at least to be considered blackened and thus removed. minimum: 0 maximum: 100

Returns:

collisionRatio

setCollisionRatio

public void setCollisionRatio(Integer collisionRatio)

redactAnnotations

public OperationBlacken redactAnnotations(Boolean redactAnnotations)

getRedactAnnotations

@Nullable
public @Nullable Boolean getRedactAnnotations()

If this value is set to \"true\", all blackened annotations will be removed. Annotations are removed completely even if they are only truncated.

Returns:

redactAnnotations

setRedactAnnotations

public void setRedactAnnotations(Boolean redactAnnotations)

redactImages

public OperationBlacken redactImages(Boolean redactImages)

getRedactImages

@Nullable
public @Nullable Boolean getRedactImages()

If this value is set to true, all blackened image data will be removed. For images, the entire image is not removed, but the obscured area is replaced by the redaction.

Returns:

redactImages

setRedactImages

public void setRedactImages(Boolean redactImages)

redactPaths

public OperationBlacken redactPaths(Boolean redactPaths)

getRedactPaths

@Nullable
public @Nullable Boolean getRedactPaths()

If this value is set to true, all blackened character paths are removed. The paths are adjusted so that the blackened section is removed from the path construction.

Returns:

redactPaths

setRedactPaths

public void setRedactPaths(Boolean redactPaths)

redactTexts

public OperationBlacken redactTexts(Boolean redactTexts)

getRedactTexts

@Nullable
public @Nullable Boolean getRedactTexts()

If this value is set to \"true\", all texts are blackened letter by letter.

Returns:

redactTexts

setRedactTexts

public void setRedactTexts(Boolean redactTexts)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object