com.oracle.outsidein.annotations

Class RedactAnnotation

java.lang.Object

com.oracle.outsidein.annotations.RedactAnnotation

public class RedactAnnotation
extends java.lang.Object

Describes redaction annotations to be added to the rendered output document.

See Also:

Annotatable.redactText(RedactAnnotation)

Constructor Summary

Constructors

Constructor and Description
RedactAnnotation(long startCharCount, long endCharCount, java.lang.String label) Creates a redaction annotation instance

Method Summary

Methods

Modifier and Type	Method and Description
long	getEndCharCount() Retrieves the character where the redaction will end
java.lang.String	getLabel() Retrieves the text that will be drawn on top of the redaction annotation area
long	getStartCharCount() Retrieves the character where the redaction will start.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactAnnotation

public RedactAnnotation(long startCharCount,
                long endCharCount,
                java.lang.String label)

Creates a redaction annotation instance

Parameters:

startCharCount - The character count of the starting position

endCharCount - The character count of the end position

label - The text to be drawn on top of the redaction

Method Detail

getStartCharCount

public long getStartCharCount()

Retrieves the character where the redaction will start.

Returns:

the index of the character where the redaction starts

getEndCharCount

public long getEndCharCount()

Retrieves the character where the redaction will end

Returns:

the index of the character where the redaction starts

getLabel

public java.lang.String getLabel()

Retrieves the text that will be drawn on top of the redaction annotation area

Returns:

the text which will be rendered on the redaction area