Randomness v3.0.0/com.fwdekker.randomness.template/Template

Template

data class Template(var name: String = DEFAULT_NAME, val schemes: MutableList<Scheme> = DEFAULT_SCHEMES, val arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR) : Scheme(source)

Generates random data by concatenating the random outputs of a list of Schemes.

Constructors

Template

constructor(name: String = DEFAULT_NAME, schemes: MutableList<Scheme> = DEFAULT_SCHEMES, arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR)

Types

Companion

object Companion

Holds constants.

Properties

actionId

val actionId: String

The identifier of the action that inserts this Template.

arrayDecorator

val arrayDecorator: ArrayDecorator

Settings that determine whether the output should be an array of values.

decorators

open override val decorators: List<ArrayDecorator>

Additional logic that determines how strings are generated.

name

open override var name: String

The unique name of the template.

schemes

val schemes: MutableList<Scheme>

The ordered list of underlying schemes.

typeIcon

open override val typeIcon: TypeIcon

The icon signifying the type of data represented by this scheme, ignoring its decorators, or null if this scheme does not represent any kind of data, as is the case for DecoratorSchemes.

Functions

applyContext

open override fun applyContext(context: Box<Settings>)

Sets the State.context of this State to context.

canReference

fun canReference(target: Template): Boolean

Returns true if this template can add a TemplateReference that refers to target without causing recursion within the current context.

deepCopy

open override fun deepCopy(retainUuid: Boolean): Template

Returns a deep copy, retaining the uuid if and only if retainUuid is true.

doValidate

open override fun doValidate(): String?

Validates the state, and indicates whether and why it is invalid.