A common interface for substituting string variables with
other strings.
The substitution algorithm and the syntax for a string variable are
not part of this interface definition. Please look at the documentation
of the implementation that must specify these parameters.
Exchanges variables inside a given text with a substitution text
defined for the variables.
The method iterates through it's internal variables list to match the
variables in the given string. A match replaces the variable with the
string defined for this variable. If no variable can be found in the string
it will be returned unchanged. The behavior if a variable is found in
the string but it is unknown for the implementation depends on the parameter
bSubstRequired.
Parameter aText
A string containing variables that should be substituted.
Parameter bSubstRequired
Specifies if a successfull substitution is required. The
function throws a ::com::sun::star::container::NoSuchElementException
if it finds a variable that is unknown. In this case it is possible
that the returned string would not be what the caller expected!
Returns
Returns a string based on aText where all variables were
exchanged with their value defined at calling time.
Tries to replace parts of aText with variables that represents
these sub strings.
The method iterates through it's internal variable list and tries to match
parts of the given string Tries to replace parts of aText with
variables that represents these sub strings.If more than one variable
matches the one with the longest matching sub string will be chosen.
Parameter aText
A string where known substrings should be replaced by variables.
Returns
Returns the resubstituted string with variables for all parts
that could be replaced. The unchanged argument will be returned
if nothing can be resubtituted.
The method iterates through it's internal variable list and tries to
find the given variable. If the variable is unkown a
::com::sun::star::container::NoSuchElementException
is thrown.
Parameter variable
The name of a variable.
Returns
Returns a string that represents the variable. If the
variable is unknown a ::com::sun::star::container::NoSuchElementException
is thrown.
