Package com.tngtech.archunit.library.freeze

Interface TextFileBasedViolationStore.RuleViolationFileNameStrategy

Enclosing class:
TextFileBasedViolationStore
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @PublicAPI(usage=INHERITANCE) public static interface TextFileBasedViolationStore.RuleViolationFileNameStrategy
Allows to adjust the rule violation file names of TextFileBasedViolationStore
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createRuleFileName(String ruleDescription)
    Returns the file name to store violations of an ArchRule, possibly based on the rule description.
    The returned names must be sufficiently unique from any others; as long as the descriptions themselves are unique, this can be achieved by sanitizing the description into some sort of file name.

  • Method Details

    • createRuleFileName

      String createRuleFileName(String ruleDescription)
      Returns the file name to store violations of an ArchRule, possibly based on the rule description.
      The returned names must be sufficiently unique from any others; as long as the descriptions themselves are unique, this can be achieved by sanitizing the description into some sort of file name.
      Parameters:
      ruleDescription - The description of the ArchRule to store
      Returns:
      The file name the respective rule violation file will have (see TextFileBasedViolationStore)