IContextualAddressingStrategy Interface

Namespace
Kampute.DocToolkit.Routing
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents an addressing strategy that requires documentation context information for initialization.
public interface IContextualAddressingStrategy : IDocumentAddressingStrategy
Extends
Implemented by

Remarks

This interface is implemented by addressing strategies that need access to documentation context during initialization to resolve topic names, configure paths, or establish other context-dependent settings. Such strategies cannot be fully configured at construction time because the required context information is not yet available.

The binding must be performed after the documentation context is loaded and before the strategy is used for address resolution. Implementations typically use lazy initialization to ensure context-dependent operations occur at the appropriate time, avoiding coordination problems with component startup order.

Methods

InitializeWithContext(IDocumentationContext)Binds the addressing strategy to the specified documentation context.

Extension Methods

TryResolveAddressByCodeReference(this IDocumentAddressingStrategy, string, out IResourceAddress)Attempts to resolve the address of the documentation content for the specified code reference.