Randomness/com.fwdekker.randomness.array/ArrayDecorator

ArrayDecorator

data class ArrayDecorator(var enabled: Boolean = DEFAULT_ENABLED, var minCount: Int = DEFAULT_MIN_COUNT, var maxCount: Int = DEFAULT_MAX_COUNT, var separatorEnabled: Boolean = DEFAULT_SEPARATOR_ENABLED, var separator: String = DEFAULT_SEPARATOR, var elementFormat: String = DEFAULT_ELEMENT_FORMAT, val affixDecorator: AffixDecorator = DEFAULT_AFFIX_DECORATOR) : DecoratorScheme(source)

The user-configurable collection of schemes applicable to generating arrays.

Constructors

constructor(enabled: Boolean = DEFAULT_ENABLED, minCount: Int = DEFAULT_MIN_COUNT, maxCount: Int = DEFAULT_MAX_COUNT, separatorEnabled: Boolean = DEFAULT_SEPARATOR_ENABLED, separator: String = DEFAULT_SEPARATOR, elementFormat: String = DEFAULT_ELEMENT_FORMAT, affixDecorator: AffixDecorator = DEFAULT_AFFIX_DECORATOR)

Types

object Companion

Holds constants.

Properties

val affixDecorator: AffixDecorator

The affixation to apply to the generated values.

open override val decorators: List<AffixDecorator>

Additional logic that determines how strings are generated.

var elementFormat: String

The format according to which each element of the array should be formatted.

var enabled: Boolean

true if and only if arrays should be generated instead of singular values.

protected open override val isEnabled: Boolean

Whether this decorator is enabled, or whether any invocation of generateStrings should be passed directly to the generator.

var maxCount: Int

The maximum number of elements to generate, inclusive.

var minCount: Int

The minimum number of elements to generate, inclusive.

open override val name: String

The name of the scheme as shown to the user.

open override val overlayIcon: OverlayIcon?

The icon signifying that a Scheme has been decorated with this decorator.

var separator: String

The string to place between generated elements.

separatorEnabled

var separatorEnabled: Boolean

Whether to separate elements using separator.

open override val validators: List<Validator<*>>

Lists the Validators relevant to this State.

Functions

open override fun deepCopy(retainUuid: Boolean): ArrayDecorator

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

generateUndecoratedStrings

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

Generates count random data according to the settings in this scheme, ignoring settings from decorators.