Randomness v3.0.0/com.fwdekker.randomness.affix/AffixDecorator

AffixDecorator

data class AffixDecorator(var enabled: Boolean = DEFAULT_ENABLED, var descriptor: String = DEFAULT_DESCRIPTOR) : DecoratorScheme(source)

Decorates a string by adding a prefix and suffix.

Constructors

AffixDecorator

constructor(enabled: Boolean = DEFAULT_ENABLED, descriptor: String = DEFAULT_DESCRIPTOR)

Types

Companion

object Companion

Holds constants.

Properties

decorators

open override val decorators: List<DecoratorScheme>

Additional logic that determines how strings are generated.

descriptor

var descriptor: String

The description of the affix. Here, '\' is the escape character (which also escapes itself), and each unescaped '@' is replaced with the original string. If the descriptor does not contain an unescaped '@', then the entire descriptor is placed both in front of and after the original string. For example, affixing "word" with descriptor "(@)" gives "(word)", and affixing "word" with descriptor "()" gives "()word()".

enabled

var enabled: Boolean

Whether to apply this decorator.

name

open override val name: String

The name of the scheme as shown to the user.

Functions

deepCopy

open override fun deepCopy(retainUuid: Boolean): AffixDecorator

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.