C# Class SimpleFramework.Xml.Filter.EnvironmentFilter

The EnvironmentFilter object is used to provide a filter that will replace the specified values with an environment variable from the OS. This can be given a delegate filter which can be used to resolve replacements should the value requested not match an environment variable from the OS.

Inheritance: Filter

Mostra file Open project: ngallagher/simplexml

Public Methods

Method	Description
EnvironmentFilter ( ) : System	Constructor for the `EnvironmentFilter` object. This creates a filter that resolves replacements using environment variables. Should the environment variables not contain the requested mapping this will return a null value.
EnvironmentFilter ( Filter filter ) : System	Constructor for the `EnvironmentFilter` object. This creates a filter that resolves replacements using environment variables. Should the environment variables not contain the requested mapping this will delegate to the specified filter.
Replace ( String text ) : String	Replaces the text provided with the value resolved from the environment variables. If the environment variables fail this will delegate to the specified `Filter` if it is not a null object. If no match is found a null is returned.

Method Details

EnvironmentFilter() public method

Constructor for the EnvironmentFilter object. This creates a filter that resolves replacements using environment variables. Should the environment variables not contain the requested mapping this will return a null value.

public EnvironmentFilter ( ) : System
return	System

EnvironmentFilter() public method

public EnvironmentFilter ( Filter filter ) : System
filter	Filter	/// the filter delegated to should resolution fail ///
return	System

Replace() public method

Replaces the text provided with the value resolved from the environment variables. If the environment variables fail this will delegate to the specified Filter if it is not a null object. If no match is found a null is returned.

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