IReadOnlyPatternCollection Interface

Namespace
Kampute.DocToolkit.Collections
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents a read-only collection of patterns that can be used to match values.
public interface IReadOnlyPatternCollection : IReadOnlyCollection<string>
Extends
Implemented by

Remarks

The IReadOnlyPatternCollection interface provides a consistent way to access and use pattern collections for string matching operations. Pattern collections are particularly useful in documentation generation for filtering and matching namespaces, type names, and other string-based identifiers.

This interface supports exact matches as well as wildcard patterns, allowing for flexible inclusion and exclusion rules when organizing documentation. The matching capabilities enable documentation tools to determine which elements should be included in generated documentation or how elements should be categorized based on their names or namespaces.

Methods

Contains(string)Determines whether the collection contains the specified namespace pattern.
Matches(string)Determines whether the specified value matches any pattern in the collection.
TryGetMatchingPattern(string, out string)Attempts to retrieve a pattern that matches the specified value.