C# Class SimpleFramework.Xml.Core.TemplateEngine

The TemplateEngine object is used to create strings which have system variable names replaced with their values. This is used by the Source context object to ensure that values taken from an XML element or attribute can be values values augmented with system or environment variable values. tools=${java.home}/lib/tools.jar Above is an example of the use of an system variable that has been inserted into a plain Java properties file. This will be converted to the full path to tools.jar when the system variable "java.home" is replaced with the matching value.
显示文件 Open project: ngallagher/simplexml Class Usage Examples

Public Methods

Method Description
Clear ( ) : void

This method is used to clear the contents of the buffer. This includes the contents of all buffers used to transform the value of the buffered text with system variable values. Once invoked the instance can be reused as a clean buffer.
Name ( ) : void

This method is used to extract text from the property value that matches the pattern "${ *TEXT }". Such patterns within the properties file are considered to be system variables, this will replace instances of the text pattern with the matching system variable, if a matching variable does not exist the value remains unmodified.
Parse ( ) : void

This extracts the value from the Java properties text. This will basically ready any text up to the first occurance of an equal of a terminal. If a terminal character is read this returns without adding the terminal to the value.
Process ( String value ) : String

This method is used to append the provided text and then it converts the buffered text to return the corrosponding text. The contents of the buffer remain unchanged after the value is buffered. It must be cleared if used as replacement only.
Replace ( ) : void

This will replace the accumulated for an system variable name with the value of that system variable. If a value does not exist for the variable name, then the name is put into the value so that the value remains unmodified.
Replace ( String name ) : void

This will replace the accumulated for an system variable name with the value of that system variable. If a value does not exist for the variable name, then the name is put into the value so that the value remains unmodified.
Replace ( Template name ) : void

This will replace the accumulated for an system variable name with the value of that system variable. If a value does not exist for the variable name, then the name is put into the value so that the value remains unmodified.
TemplateEngine ( Filter filter ) : SimpleFramework.Xml.Filter

Constructor for the TemplateEngine object. This is used to create a parsing buffer, which can be used to replace filter variable names with their corrosponding values.

Method Details

Clear() public method

This method is used to clear the contents of the buffer. This includes the contents of all buffers used to transform the value of the buffered text with system variable values. Once invoked the instance can be reused as a clean buffer.
public Clear ( ) : void
return void

Name() public method

This method is used to extract text from the property value that matches the pattern "${ *TEXT }". Such patterns within the properties file are considered to be system variables, this will replace instances of the text pattern with the matching system variable, if a matching variable does not exist the value remains unmodified.
public Name ( ) : void
return void

Parse() public method

This extracts the value from the Java properties text. This will basically ready any text up to the first occurance of an equal of a terminal. If a terminal character is read this returns without adding the terminal to the value.
public Parse ( ) : void
return void

Process() public method

This method is used to append the provided text and then it converts the buffered text to return the corrosponding text. The contents of the buffer remain unchanged after the value is buffered. It must be cleared if used as replacement only.
public Process ( String value ) : String
value String /// this is the value to append to the buffer ///
return String

Replace() public method

This will replace the accumulated for an system variable name with the value of that system variable. If a value does not exist for the variable name, then the name is put into the value so that the value remains unmodified.
public Replace ( ) : void
return void

Replace() public method

This will replace the accumulated for an system variable name with the value of that system variable. If a value does not exist for the variable name, then the name is put into the value so that the value remains unmodified.
public Replace ( String name ) : void
name String /// this is the name of the system variable ///
return void

Replace() public method

This will replace the accumulated for an system variable name with the value of that system variable. If a value does not exist for the variable name, then the name is put into the value so that the value remains unmodified.
public Replace ( Template name ) : void
name Template /// this is the name of the system variable ///
return void

TemplateEngine() public method

Constructor for the TemplateEngine object. This is used to create a parsing buffer, which can be used to replace filter variable names with their corrosponding values.
public TemplateEngine ( Filter filter ) : SimpleFramework.Xml.Filter
filter Filter /// this is the filter used to provide replacements ///
return SimpleFramework.Xml.Filter