Embabel Agent Documentation/com.embabel.agent.config.migration/DeprecatedPropertyScanner/PropertyMigrationRule

PropertyMigrationRule

data class PropertyMigrationRule(val pattern: Pattern, val replacement: String, val description: String, val condition: (String) -> Boolean? = null)

Data class representing a property migration rule with pattern matching.

Used for runtime extensibility when explicit mappings are insufficient. Most migrations use explicit mappings in exactPropertyMappings for safety.

Usage Example (Runtime Extension)

PropertyMigrationRule(
    pattern = Pattern.compile("custom\\.company\\.(.+)"),
    replacement = "embabel.agent.custom.$1",
    description = "Custom company namespace migration"
)

Constructors

PropertyMigrationRule

constructor(pattern: Pattern, replacement: String, description: String, condition: (String) -> Boolean? = null)

Properties

condition

val condition: (String) -> Boolean? = null

description

val description: String

pattern

val pattern: Pattern

replacement

val replacement: String

Functions

tryApply

fun tryApply(property: String): String?

Attempts to transform a deprecated property name into its recommended replacement.