public interface CompatibilityHelper
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NEWLINE
Newline text on the system on which this tool runs.
|
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 |
closeContentTypeComment()
Return the text used to end a comment that removes the META or
WSMETA element with an HTTP-EQUIV attribute that is set to
CONTENT-TYPE.
|
java.lang.String |
closeExprEscape()
Return the text used to end the output of an embedded 4GL expression.
|
java.lang.String |
closeHTML(boolean content)
Return the text used to end a line of raw HTML output.
|
java.lang.String |
entityConvert(java.lang.String e4gl)
Convert any HTML entities (in the given E4GL text) into the equivalent
characters.
|
java.lang.String |
escapeHTML(java.lang.String html)
Convert any unsafe characters (in the given HTML text) into equivalents
that are safe to embed in a 4GL string literal and return that converted
text.
|
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.
|
java.lang.String |
openContentTypeComment()
Return the text used to start a comment that removes the META or
WSMETA element with an HTTP-EQUIV attribute that is set to
CONTENT-TYPE.
|
java.lang.String |
openExprEscape()
Return the text used to start the output of an embedded 4GL expression.
|
java.lang.String |
openHTML(boolean content)
Return the text used to start a line of raw HTML output.
|
java.lang.String |
suffix()
Return the filename suffix (extension) to be used.
|
static final java.lang.String NEWLINE
void initialize(Options opts)
opts
- The configuration.java.lang.String suffix()
java.lang.String header()
java.lang.String openHTML(boolean content)
content
- true
if there is HTML content that is about to
be emitted on the line, false
to handle the
no content case (just start the line, without any
content prefix text).java.lang.String closeHTML(boolean content)
content
- true
if there is content that needs to be
finished on the line, false
to handle the
no content case (just terminate the line, without any
content termination text).java.lang.String escapeHTML(java.lang.String html)
java.lang.String entityConvert(java.lang.String e4gl)
java.lang.String openExprEscape()
java.lang.String closeExprEscape()
java.lang.String openComment(boolean expr)
expr
- true
if this is an expression escape,
false
for a statement escape.null
if the escape should be removed instead of commented.java.lang.String closeComment(boolean expr)
expr
- true
if this is an expression escape,
false
for a statement escape.null
if the escape should be removed instead of commented.java.lang.String openContentTypeComment()
java.lang.String closeContentTypeComment()
java.lang.String footer()