com.tplan.robot.scripting

Class CommentCollector

java.lang.Object

com.tplan.robot.scripting.CommentCollector

public class CommentCollector
extends Object

Utility capable of collecting of script comments and exporting them in various formats (plain text, HTML, MS Word).

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_COMMENT

Constructor Summary

Constructors

Constructor and Description
CommentCollector()

Method Summary

Modifier and Type	Method and Description
static CommentCollector	getCommentCollector(ScriptingContext ctx) Get the comment collector associated with the given context.
int	getSize() Get number of comments recorded in the comment collection (typically one comment is one line of text).
static String[]	getSupportedOutputFormatDescriptions() Get descriptions of the supported output formats such as "Plain text document (*.txt)" for the "txt" format.The array has the same order and size as the one returned by getSupportedOutputFormats().
static String[]	getSupportedOutputFormats() Get the supported output formats as lower case file extensions, such as "txt" for plain text format or "docx" for MS Word 2007 XML.
boolean	recordComment(Element element, ScriptingContext ctx) Record a comment detected during a script compilation or execution..
String	toHTML(boolean standalone) Export the comment collection to the HTML format and return it.
void	toHTML(OutputStream out)
void	toPlainText(OutputStream out, String content)
String	toString() Overridden to return the comment collection exported to plain text.
void	toWord(OutputStream out, String content)
void	write(OutputStream out, String format, String content) Write the recorded comments or the customized content in the specified format to the specified output stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_COMMENT

public static final int TYPE_COMMENT

See Also:

Constant Field Values

Constructor Detail

CommentCollector

public CommentCollector()

Method Detail

getCommentCollector

public static CommentCollector getCommentCollector(ScriptingContext ctx)

Get the comment collector associated with the given context. The method is null-safe meaning that if the context hasn't been associated with a comment collector, the method will create a new one, put it into the context and return it.

Parameters:

ctx - a valid context. If the argument is null the method will throw a NullPointerException.

Returns:

comment collector.

recordComment

public boolean recordComment(Element element,
                             ScriptingContext ctx)

Record a comment detected during a script compilation or execution..

Parameters:

element - the document element containing the comment.

ctx - a context.

Returns:

true if the comment was recorded. The value of false is returned if the comment is rejected, typically because its location does not meet the rules configured for the collector (comments inside procedures, comments inside structured blocks such as if/else or for, ...).

getSupportedOutputFormats

public static String[] getSupportedOutputFormats()

Get the supported output formats as lower case file extensions, such as "txt" for plain text format or "docx" for MS Word 2007 XML.

Returns:

array of supported formats (file extensions).

getSupportedOutputFormatDescriptions

public static String[] getSupportedOutputFormatDescriptions()

Get descriptions of the supported output formats such as "Plain text document (*.txt)" for the "txt" format.The array has the same order and size as the one returned by getSupportedOutputFormats().

Returns:

array of supported format descriptions.

write

public void write(OutputStream out,
                  String format,
                  String content)
           throws IOException

Write the recorded comments or the customized content in the specified format to the specified output stream.

Parameters:

out - an output stream to write to.

format - format (file extension) listed as supported by getSupportedOutputFormats(). If the specified format is not supported, the method throws an IllegalArgumentException.

content - optional customized comment text. This allows to write comments which were first generated through toString() and then customized by the user, for example in a text editor in the GUI. If the argument is null, the method will create the comment text from the recorded comments.

Throws:

IOException - if writing to the specified output stream fails.

toPlainText

public void toPlainText(OutputStream out,
                        String content)
                 throws IOException

Throws:

IOException

toHTML

public void toHTML(OutputStream out)
            throws IOException

Throws:

IOException

toWord

public void toWord(OutputStream out,
                   String content)
            throws IOException

Throws:

IOException

toString

public String toString()

Overridden to return the comment collection exported to plain text.

Overrides:

toString in class Object

Returns:

comment collection as plain text.

toHTML

public String toHTML(boolean standalone)

Export the comment collection to the HTML format and return it.

Parameters:

standalone - the value of true creates a complete HTML document including the 'html' and 'body' tags. The value of false produces HTML suitable for insertion into another HTML document.

Returns:

resulting HTML code.

getSize

public int getSize()

Get number of comments recorded in the comment collection (typically one comment is one line of text).

Returns:

number of comments.