DeferredVariables Class Reference

Static Public Member Functions
static String	get (String id, Format format)
static	set (String id, Number value)

Static Public Attributes
static String	separator

Detailed Description

Deferred variables handling class.

This class is used for handling values, which are not known at the time they are output. For example, reference to a sub-program's line number. Use the following code to output a deferred variable.

writeBlock(DeferredVariables.get(id, format));

• 'id' is the unique string identifier of the deferred variable when it was defined using the 'DeferredVariable.set' function.
• 'format' is optional and is the FormatNumber used to format a numeric variable.

Use the following code at the place where the variable is known and gets defined (for example, the line number becomes known).

DeferredVariables.set(id, value);

• 'id' is a unique identifier assigned to the deferred variable.
• 'value' is the value to assign to the deferred variable.

Deferred variable ids will be replaced with the value of the deferred variables at the end of processing.

Since

r45238

Member Function Documentation

get()

static String get ( String  id, Format  format  )

static

Function for retrieving the deferred variable for output.

Parameters

id	An unique string identifier of deferred variable to output.
format	FormatNumber used to format a numeric variable. 'format' is optional and won't be used to format non-numeric values. If it is not specified, then numeric values are not formatted prior to output.

Returns

Returns the formatted string of the deferred variable, if it is defined, and string "##ID##", if not. If the variable is not defined, then the post will fail with an error after it has finished processing and a '.failed' file will be generated.

set()

static set ( String  id, Number  value  )

static

Function for setting deferred variable's value.

Parameters

id	An unique string identifier of variable to output.
value	Actual value of variable.

Member Data Documentation

separator

String separator

static

Deferred variables id separator.

This property should be set to a unique test string that cannot be found in the output. Default value: "##"