com.goldencode.p2j.e4gl

Class WebSpeedHelper

java.lang.Object

com.goldencode.p2j.e4gl.BaseHelper

com.goldencode.p2j.e4gl.WebSpeedHelper

All Implemented Interfaces:

CompatibilityHelper

Direct Known Subclasses:

WebSpeedStrictHelper

public class WebSpeedHelper
extends BaseHelper

Assists in creating WebSpeed-specific output text. Note that this class does not emit any WebSpeed include files that are normally inserted in the header of every generated file. This eliminates the use of PSC written technology in the resulting file, at the expense of strict compatibility.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	FOOTER_SPEC Standard WebSpeed footer template.
private static java.lang.String	LOCAL_OPTS_SPEC Standard WebSpeed local-e4gl-options procedure template.
private static java.lang.String	VERSION WebSpeed E4GL version string.

Fields inherited from class com.goldencode.p2j.e4gl.BaseHelper

entities, opts, unsafe

Fields inherited from interface com.goldencode.p2j.e4gl.CompatibilityHelper

NEWLINE

Constructor Summary

Constructors

Constructor and Description
WebSpeedHelper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	closeComment(boolean expr) Return the text used to end a comment that removes the start or end tag for a statement or expression escape.
java.lang.String	footer() Return the text for the footer of the generated file.
java.lang.String	header() Return the text for the header of the generated file.
void	initialize(Options opts) Provides the known configuration to the helper and allows it to prepare for use.
java.lang.String	openComment(boolean expr) Return the text used to start a comment that removes the start or end tag for a statement or expression escape.

Methods inherited from class com.goldencode.p2j.e4gl.BaseHelper

closeContentTypeComment, closeExprEscape, closeHTML, entityConvert, escapeHTML, openContentTypeComment, openExprEscape, openHTML, replace, suffix

Methods inherited from class java.lang.Object

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

Field Detail

FOOTER_SPEC

private static final java.lang.String FOOTER_SPEC

Standard WebSpeed footer template.

LOCAL_OPTS_SPEC

private static final java.lang.String LOCAL_OPTS_SPEC

Standard WebSpeed local-e4gl-options procedure template.

VERSION

private static final java.lang.String VERSION

WebSpeed E4GL version string.

See Also:

Constant Field Values

Constructor Detail

WebSpeedHelper

public WebSpeedHelper()

Method Detail

initialize

public void initialize(Options opts)

Provides the known configuration to the helper and allows it to prepare for use. This must be called before any other method can be used.

Specified by:

initialize in interface CompatibilityHelper

Overrides:

initialize in class BaseHelper

Parameters:

opts - The configuration.

header

public java.lang.String header()

Return the text for the header of the generated file. This is output before any parsed content.

Specified by:

header in interface CompatibilityHelper

Overrides:

header in class BaseHelper

Returns:

The text to use based on the known options.

openComment

public java.lang.String openComment(boolean expr)

Return the text used to start a comment that removes the start or end tag for a statement or expression escape.

Specified by:

openComment in interface CompatibilityHelper

Overrides:

openComment in class BaseHelper

Parameters:

expr - true if this is an expression escape, false for a statement escape.

Returns:

The text to use based on the known options. null if the escape should be removed instead of commented.

closeComment

public java.lang.String closeComment(boolean expr)

Return the text used to end a comment that removes the start or end tag for a statement or expression escape.

Specified by:

closeComment in interface CompatibilityHelper

Overrides:

closeComment in class BaseHelper

Parameters:

expr - true if this is an expression escape, false for a statement escape.

Returns:

The text to use based on the known options. null if the escape should be removed instead of commented.

footer

public java.lang.String footer()

Return the text for the footer of the generated file. This is output after all parsed content.

Specified by:

footer in interface CompatibilityHelper

Overrides:

footer in class BaseHelper

Returns:

The text to use based on the known options.