Randomness/com.fwdekker.randomness.word/WordScheme

WordScheme

data class WordScheme(var words: List<String> = DEFAULT_WORDS, var capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, val affixDecorator: AffixDecorator = DEFAULT_AFFIX_DECORATOR, val arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR) : Scheme(source)

Contains settings for generating random words.

Constructors

WordScheme

constructor(words: List<String> = DEFAULT_WORDS, capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, affixDecorator: AffixDecorator = DEFAULT_AFFIX_DECORATOR, arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR)

Types

Companion

object Companion

Holds constants.

Properties

affixDecorator

val affixDecorator: AffixDecorator

The affixation to apply to the generated values.

arrayDecorator

val arrayDecorator: ArrayDecorator

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

capitalization

var capitalization: CapitalizationMode

The way in which the generated word should be capitalized.

decorators

open override val decorators: List<DecoratorScheme>

Additional logic that determines how strings are generated.

name

open override val name: String

The name of the scheme as shown to the user.

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.

words

var words: List<String>

The list of words to choose from.

Functions

deepCopy

open override fun deepCopy(retainUuid: Boolean): WordScheme

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.

generateUndecoratedStrings

protected open override fun generateUndecoratedStrings(count: Int): List<String>

Returns count formatted random words.