com.pega.pegarules.pub.generator

Interface ICodeBuffer

public interface ICodeBuffer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
ICodeBuffer	decreaseIndent() Decreases the indentation level by one.
ICodeBuffer	decreaseIndent(int aLevels) Decreases the indentation level.
ICodeBuffer	decreaseIndentAS() Decreases the indentation level by one for "appendString" content.
ICodeBuffer	decreaseIndentAS(int aLevels) Decreases the indentation level for "appendString" content.
ICodeBuffer	emit(java.lang.String aContent) Adds specified content fragment to primary buffer.
ICodeBuffer	emitAS(java.lang.String aContent) Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method.
ICodeBuffer	emitASconst(java.lang.String aContent) Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method.
ICodeBuffer	emitASconstln(java.lang.String aContent) Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method.
ICodeBuffer	emitAScsf(java.lang.String aContent) Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method.
ICodeBuffer	emitASln(java.lang.String aContent) Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method.
ICodeBuffer	emitASraw(java.lang.String aContent) Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method.
ICodeBuffer	emitCSF(java.lang.String aContent) Adds specified content fragment to primary buffer after processing it through StringUtils.crossScriptingFilter.
ICodeBuffer	emitCSFln(java.lang.String aContent) Adds specified content fragment to primary buffer after processing it through StringUtils.crossScriptingFilter and then appends a newline character.
ICodeBuffer	emitEscaped(java.lang.String aContent) Adds specified content fragment to primary buffer after processing it through StringUtils.escapeIntoJavaString.
ICodeBuffer	emitEscapedln(java.lang.String aContent) Adds specified content fragment to primary buffer after processing it through StringUtils.escapeIntoJavaString and then appends a newline character.
ICodeBuffer	emitln(java.lang.String aContent) Adds specified content fragment to primary buffer followed by a newline character.
ICodeBuffer	increaseIndent() Increases the indentation level by one.
ICodeBuffer	increaseIndent(int aLevels) Increases the indentation level.
ICodeBuffer	increaseIndentAS() Increases the indentation level by one for "appendString" content.
ICodeBuffer	increaseIndentAS(int aLevels) Increases the indentation level for "appendString" content.
ICodeBuffer	setIndentContent(java.lang.String aIndentContent) Sets the desired String to use for each indentation level.
ICodeBuffer	setIndentContentAS(java.lang.String aIndentContent) Sets the desired String to use for each indentation level for "appendString" content.
ICodeBuffer	setIndentLevel(int aLevel) Sets the desired indentation level (e.g.
ICodeBuffer	setIndentLevelAS(int aLevel) Sets the desired indentation level (e.g.

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

setIndentLevel

ICodeBuffer setIndentLevel(int aLevel)

Sets the desired indentation level (e.g. number of leading tab characters)

Parameters:

aLevel - desired level; if less than 0, then 0 will be used

Returns:

CodeBuffer instance

setIndentContent

ICodeBuffer setIndentContent(java.lang.String aIndentContent)

Sets the desired String to use for each indentation level. Defaults to "\t". If, for example, you prefer two spaces then use " ".

Parameters:

aIndentContent - content for each indentation level.

Returns:

CodeBuffer instance

increaseIndent

ICodeBuffer increaseIndent()

Increases the indentation level by one.

Returns:

CodeBuffer instance

increaseIndent

ICodeBuffer increaseIndent(int aLevels)

Increases the indentation level.

Parameters:

aLevels - number of levels to increase

Returns:

CodeBuffer instance

decreaseIndent

ICodeBuffer decreaseIndent()

Decreases the indentation level by one. If this would reduce the level to less than zero, the 0 will be used.

Returns:

CodeBuffer instance

decreaseIndent

ICodeBuffer decreaseIndent(int aLevels)

Decreases the indentation level. If this would reduce the level to less than zero, the 0 will be used.

Parameters:

aLevels - number of levels to decrease

Returns:

CodeBuffer instance

emit

ICodeBuffer emit(java.lang.String aContent)

Adds specified content fragment to primary buffer. If this content starts on a new line, then the appropriate indentation will be added prior to the content.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitln

ICodeBuffer emitln(java.lang.String aContent)

Adds specified content fragment to primary buffer followed by a newline character. If this content starts on a new line, then the appropriate indentation will be added prior to the content.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitEscaped

ICodeBuffer emitEscaped(java.lang.String aContent)

Adds specified content fragment to primary buffer after processing it through StringUtils.escapeIntoJavaString. If this content starts on a new line, then the appropriate indentation will be added prior to the content.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitEscapedln

ICodeBuffer emitEscapedln(java.lang.String aContent)

Adds specified content fragment to primary buffer after processing it through StringUtils.escapeIntoJavaString and then appends a newline character. If this content starts on a new line, then the appropriate indentation will be added prior to the content.

Parameters:

aDepth - number of additional times the content should be escaped (specify 0 to escape once, the most typical use)

aContent - content to be added

Returns:

CodeBuffer instance

emitCSF

ICodeBuffer emitCSF(java.lang.String aContent)

Adds specified content fragment to primary buffer after processing it through StringUtils.crossScriptingFilter. If this content starts on a new line, then the appropriate indentation will be added prior to the content.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitCSFln

ICodeBuffer emitCSFln(java.lang.String aContent)

Adds specified content fragment to primary buffer after processing it through StringUtils.crossScriptingFilter and then appends a newline character. If this content starts on a new line, then the appropriate indentation will be added prior to the content.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

setIndentLevelAS

ICodeBuffer setIndentLevelAS(int aLevel)

Sets the desired indentation level (e.g. number of leading tab characters) for "appendString" content.

Parameters:

aLevel - desired level; if less than 0, then 0 will be used

Returns:

CodeBuffer instance

setIndentContentAS

ICodeBuffer setIndentContentAS(java.lang.String aIndentContent)

Sets the desired String to use for each indentation level for "appendString" content. Defaults to "\t". If, for example, you prefer two spaces then use " ".

Parameters:

aIndentContent - content for each indentation level.

Returns:

CodeBuffer instance

increaseIndentAS

ICodeBuffer increaseIndentAS()

Increases the indentation level by one for "appendString" content.

Returns:

CodeBuffer instance

increaseIndentAS

ICodeBuffer increaseIndentAS(int aLevels)

Increases the indentation level for "appendString" content.

Parameters:

aLevels - number of levels to increase

Returns:

CodeBuffer instance

decreaseIndentAS

ICodeBuffer decreaseIndentAS()

Decreases the indentation level by one for "appendString" content. Implicitly emits a newline after increasing the indentation. If this would reduce the level to less than zero, the 0 will be used.

Returns:

CodeBuffer instance

decreaseIndentAS

ICodeBuffer decreaseIndentAS(int aLevels)

Decreases the indentation level for "appendString" content. Implicitly emits a newline after decreasing the indentation. If this would reduce the level to less than zero, the 0 will be used.

Parameters:

aLevels - number of levels to decrease

Returns:

CodeBuffer instance

emitAS

ICodeBuffer emitAS(java.lang.String aContent)

Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method. If this sequence of content starts on a new line, then the appropriate indentation will be added prior to the content.

The content will be processed through StringUtils.escapeIntoJavaString.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitASln

ICodeBuffer emitASln(java.lang.String aContent)

Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method. A newline will be appended to the end of the appendString content, with appropriate indentation on the following appendString output. If this sequence of content starts on a new line, then the appropriate indentation will be added prior to the content.

The content will be processed through StringUtils.escapeIntoJavaString.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitASconst

ICodeBuffer emitASconst(java.lang.String aContent)

Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method. If this sequence of content starts on a new line, then the appropriate indentation will be added prior to the content.

The content will be processed through StringUtils.escapeIntoJavaString and then surrounded by quotation marks so that the content is treated as a constant String. Consecutive calls to "emitASconst" will have their content merged to a single constant String.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitASconstln

ICodeBuffer emitASconstln(java.lang.String aContent)

Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method. A newline will be appended to the end of the appendString content, with appropriate indentation on the following appendString output. If this sequence of content starts on a new line, then the appropriate indentation will be added prior to the content.

The content will be processed through StringUtils.escapeIntoJavaString and then surrounded by quotation marks so that the content is treated as a constant String. Consecutive calls to "emitASconst" will have their content merged to a single constant String.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitASraw

ICodeBuffer emitASraw(java.lang.String aContent)

Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method. If this sequence of content starts on a new line, then the appropriate indentation will be added prior to the content. Unlike the other "emitAS*" methods, the content will NOT be processed through StringUtils.escapeIntoJavaString.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance

emitAScsf

ICodeBuffer emitAScsf(java.lang.String aContent)

Accumulates the specified content which will be added to the primary buffer at the end of sequence of "emitAS*" method calls as the parameter to the "tools.appendString()" method. If this sequence of content starts on a new line, then the appropriate indentation will be added prior to the content. The content will be processed through StringUtils.escapeIntoJavaString and then, at run-time, passed through StringUtils.crossScriptingFilter.

Parameters:

aContent - content to be added

Returns:

CodeBuffer instance