C# Class SimpleFramework.Xml.Filter.StackFilter

The StackFilter object provides a filter that can be given a collection of filters which can be used to resolve a replacement. The order of the resolution used for this filter is last in first used. This order allows the highest priority filter to be added last within the stack.

Inheritance: Filter

Exibir arquivo Open project: ngallagher/simplexml Class Usage Examples

Public Methods

Method	Description
Push ( Filter filter ) : void	This pushes the the provided `Filter` on to the top of the stack. The last filter pushed on to the stack has the highes priority in the resolution of a replacement value.
Replace ( String text ) : String	Replaces the text provided with the value resolved from the stacked filters. This attempts to resolve a replacement from the top down. So the last `Filter` pushed on to the stack will be the first filter queried for a replacement.
StackFilter ( ) : System.Collections.Generic	Constructor for the `StackFilter` object. This will create an empty filter that initially resolves null for all replacements requested. As filters are pushed into the stack the `replace` method can resolve replacements.

Method Details

Push() public method

This pushes the the provided Filter on to the top of the stack. The last filter pushed on to the stack has the highes priority in the resolution of a replacement value.

public Push ( Filter filter ) : void
filter	Filter	/// this is a filter to be pushed on to the stack ///
return	void

Replace() public method

Replaces the text provided with the value resolved from the stacked filters. This attempts to resolve a replacement from the top down. So the last Filter pushed on to the stack will be the first filter queried for a replacement.

public Replace ( String text ) : String
text	String	/// this is the text value to be replaced ///
return	String

StackFilter() public method

Constructor for the StackFilter object. This will create an empty filter that initially resolves null for all replacements requested. As filters are pushed into the stack the replace method can resolve replacements.

public StackFilter ( ) : System.Collections.Generic
return	System.Collections.Generic