C# Class CK.RouteConfig.RouteConfiguration

Primary configuration object that contains multiple SubRouteConfigurations and ActionConfigurations.
Datei anzeigen Open project: Invenietis/ck-core Class Usage Examples

Public Methods

Method Description
AddAction ( ActionConfiguration a ) : RouteConfiguration

Adds one or more ActionConfiguration.

DeclareAction ( ActionConfiguration a ) : RouteConfiguration

Declares one or more ActionConfiguration. It can be inserted later thanks to InsertAction.

DeclareRoute ( SubRouteConfiguration route ) : RouteConfiguration

Declare a new subordinated route.

InsertAction ( string name, string declarationName ) : RouteConfiguration

Inserts a previously declared action.

OverrideAction ( ActionConfiguration a ) : RouteConfiguration

Overrides one or more existing ActionConfiguration (lookup is done by name).

RemoveAction ( string name ) : RouteConfiguration

Removes one or more existing ActionConfiguration.

Resolve ( IActivityMonitor monitor ) : RouteConfigurationResult

Attempts to resolve the configuration. Null if an error occurred.

RouteConfiguration ( ) : System

Initializes a new root RouteConfiguration.

Protected Methods

Method Description
AddMeta ( MetaConfiguration m ) : void

Protected method to actually add any MetaConfiguration object.

RouteConfiguration ( string name ) : System

Initializes a specialized RouteConfiguration.

Method Details

AddAction() public method

Adds one or more ActionConfiguration.
public AddAction ( ActionConfiguration a ) : RouteConfiguration
a ActionConfiguration The first configuration.
return RouteConfiguration

AddMeta() protected method

Protected method to actually add any MetaConfiguration object.
protected AddMeta ( MetaConfiguration m ) : void
m CK.RouteConfig.Impl.MetaConfiguration A meta configuration to add.
return void

DeclareAction() public method

Declares one or more ActionConfiguration. It can be inserted later thanks to InsertAction.
public DeclareAction ( ActionConfiguration a ) : RouteConfiguration
a ActionConfiguration The first configuration to declare.
return RouteConfiguration

DeclareRoute() public method

Declare a new subordinated route.
public DeclareRoute ( SubRouteConfiguration route ) : RouteConfiguration
route SubRouteConfiguration The subordinated route configuration.
return RouteConfiguration

InsertAction() public method

Inserts a previously declared action.
public InsertAction ( string name, string declarationName ) : RouteConfiguration
name string The name of the inserted configuration.
declarationName string The name of the previously declared action.
return RouteConfiguration

OverrideAction() public method

Overrides one or more existing ActionConfiguration (lookup is done by name).
public OverrideAction ( ActionConfiguration a ) : RouteConfiguration
a ActionConfiguration The first configuration to override.
return RouteConfiguration

RemoveAction() public method

Removes one or more existing ActionConfiguration.
public RemoveAction ( string name ) : RouteConfiguration
name string The first configuration name to remove.
return RouteConfiguration

Resolve() public method

Attempts to resolve the configuration. Null if an error occurred.
public Resolve ( IActivityMonitor monitor ) : RouteConfigurationResult
monitor IActivityMonitor Monitor to use. Must not be null.
return RouteConfigurationResult

RouteConfiguration() public method

Initializes a new root RouteConfiguration.
public RouteConfiguration ( ) : System
return System

RouteConfiguration() protected method

Initializes a specialized RouteConfiguration.
protected RouteConfiguration ( string name ) : System
name string Name of the route. Can not be null.
return System