Updater/io.github.vxrpenter.updater.schema/Schema

Schema

inline fun Schema(builder: SchemaBuilder.() -> Unit = {}): DefaultUpdateSchema(source)

The Schema function is an easy way to creating a DefaultUpdateSchema, by providing simple solutions and an easy-to-understand format. If you want to use a more complex function, you can use the SchemaBuilder.

Example Usage:

val schema = Schema {
    prefix = "v"
    divider = "."
    classifier {
        value = "alpha"
        divider = "-"
        priority = ClassifierPriority.LOW
    }
    classifier {
        value = "beta"
        divider = "-"
        priority = ClassifierPriority.HIGH
    }
    classifier {
        value = "rc"
        divider = "-"
        priority = ClassifierPriority.HIGHEST
    }
}
Content copied to clipboard

Return

the DefaultUpdateSchema

Parameters

SchemaBuilder.prefixes

Defines the beginning of a version, e.g. v or v.

SchemaBuilder.divider

The symbol that is used to divide the version components, e.g. . or -

SchemaBuilder.classifier

Version classifier

See also