com.pega.pegarules.pub.runtime

Interface StreamBuilder

All Superinterfaces:

GeneratedJava

public interface StreamBuilder
extends GeneratedJava

The StreamBuilder interface is implemented by the Java which is generated by First-Use Assembly based on Rule-Stream instances.

Version:

$Revision: 69724 $ $Date: 2013-09-24 15:19:02 -0400 (Tue, 24 Sep 2013) $

Author:

John van der Meer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static byte	FMT_BLOCK Formatting option; NORMAL formating, and replace each newline with <BR>.
static byte	FMT_JAVASCRIPT Formatting option; format for output to be included in a JavaScript string.
static byte	FMT_LITERAL Formatting option; leave string unchanged.
static byte	FMT_NORMAL Formatting option; convert special characters to corresponding HTML entities (&, ", <, >).
static byte	FMT_RICHTEXT Formatting option; format for rich text, i.e.
static byte	FMT_STREAM Formatting option; NORMAL formating, and replace each newline and <BR> with a space.
static byte	FMT_TEXT Formatting option; NORMAL formating, and replace each <BR> with a newline.
static long	MODE_INPUT_ENABLED When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the stream should be displayed with input enabled.
static long	MODE_NO_INPUT When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the stream should be displayed with input not enabled.
static long	MODE_PREVIEW When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the stream should be displayed in preview mode.
static long	MODE_STREAMING_DISABLED When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the (included) stream output MUST NEVER be direct streamed.
static long	MODE_STREAMING_PERMITTED When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the (included) stream output may be direct streamed.
static java.lang.String	sInputEnabled Value of "pzInput" (in StringMap to PublicAPI.getStream(StringMap, ClipboardPage) method) for Rule-Obj-HTML streams when input is permitted.
static java.lang.String	sNoInput Value of "pzInput" (in StringMap to PublicAPI.getStream(StringMap, ClipboardPage) method) for Rule-Obj-HTML streams when input is not permitted.
static java.lang.String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method defines the processing associated with each implementation of StreamBuilder.
boolean	isDirectiveStream() Is this a (deprecated) directive-based stream?

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

sInputEnabled

static final java.lang.String sInputEnabled

Value of "pzInput" (in StringMap to PublicAPI.getStream(StringMap, ClipboardPage) method) for Rule-Obj-HTML streams when input is permitted.

See Also:

Constant Field Values

sNoInput

static final java.lang.String sNoInput

Value of "pzInput" (in StringMap to PublicAPI.getStream(StringMap, ClipboardPage) method) for Rule-Obj-HTML streams when input is not permitted.

See Also:

Constant Field Values

FMT_LITERAL

static final byte FMT_LITERAL

Formatting option; leave string unchanged.

See Also:

Constant Field Values

FMT_NORMAL

static final byte FMT_NORMAL

Formatting option; convert special characters to corresponding HTML entities (&, ", <, >).

See Also:

Constant Field Values

FMT_STREAM

static final byte FMT_STREAM

Formatting option; NORMAL formating, and replace each newline and <BR> with a space.

See Also:

Constant Field Values

FMT_BLOCK

static final byte FMT_BLOCK

Formatting option; NORMAL formating, and replace each newline with <BR>.

See Also:

Constant Field Values

FMT_TEXT

static final byte FMT_TEXT

Formatting option; NORMAL formating, and replace each <BR> with a newline.

See Also:

Constant Field Values

FMT_JAVASCRIPT

static final byte FMT_JAVASCRIPT

Formatting option; format for output to be included in a JavaScript string.

See Also:

Constant Field Values

FMT_RICHTEXT

static final byte FMT_RICHTEXT

Formatting option; format for rich text, i.e. user-supplied HTML

See Also:

Constant Field Values

MODE_INPUT_ENABLED

static final long MODE_INPUT_ENABLED

When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the stream should be displayed with input enabled.

See Also:

Constant Field Values

MODE_NO_INPUT

static final long MODE_NO_INPUT

When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the stream should be displayed with input not enabled. This mode is the default.

See Also:

Constant Field Values

MODE_PREVIEW

static final long MODE_PREVIEW

When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the stream should be displayed in preview mode.

See Also:

Constant Field Values

MODE_STREAMING_PERMITTED

static final long MODE_STREAMING_PERMITTED

When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the (included) stream output may be direct streamed.

See Also:

Constant Field Values

MODE_STREAMING_DISABLED

static final long MODE_STREAMING_DISABLED

When this is used with the bitmap parameter of PublicAPI.getStream(StringMap, ClipboardPage, long), it indicates that the (included) stream output MUST NEVER be direct streamed.

See Also:

Constant Field Values

Method Detail

execute

void execute()

The execute method defines the processing associated with each implementation of StreamBuilder.

isDirectiveStream

boolean isDirectiveStream()

Is this a (deprecated) directive-based stream?

Returns:

true iff it is