Randomness v3.0.0/com.fwdekker.randomness.decimal/DecimalScheme

DecimalScheme

data class DecimalScheme(var minValue: Double = DEFAULT_MIN_VALUE, var maxValue: Double = DEFAULT_MAX_VALUE, var decimalCount: Int = DEFAULT_DECIMAL_COUNT, var showTrailingZeroes: Boolean = DEFAULT_SHOW_TRAILING_ZEROES, var decimalSeparator: String = DEFAULT_DECIMAL_SEPARATOR, var groupingSeparatorEnabled: Boolean = DEFAULT_GROUPING_SEPARATOR_ENABLED, var groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, val affixDecorator: AffixDecorator = DEFAULT_AFFIX_DECORATOR, val arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR) : Scheme(source)

Contains settings for generating random decimals.

Constructors

DecimalScheme

constructor(minValue: Double = DEFAULT_MIN_VALUE, maxValue: Double = DEFAULT_MAX_VALUE, decimalCount: Int = DEFAULT_DECIMAL_COUNT, showTrailingZeroes: Boolean = DEFAULT_SHOW_TRAILING_ZEROES, decimalSeparator: String = DEFAULT_DECIMAL_SEPARATOR, groupingSeparatorEnabled: Boolean = DEFAULT_GROUPING_SEPARATOR_ENABLED, groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, 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.

decimalCount

var decimalCount: Int

The number of decimals to display.

decimalSeparator

var decimalSeparator: String

The character that should separate decimals.

decorators

open override val decorators: List<DecoratorScheme>

Additional logic that determines how strings are generated.

groupingSeparator

var groupingSeparator: String

The character that should separate groups if groupingSeparatorEnabled is true.

groupingSeparatorEnabled

var groupingSeparatorEnabled: Boolean

true if and only if the groupingSeparator should be used to separate groups.

maxValue

var maxValue: Double

The maximum value to be generated, inclusive.

minValue

var minValue: Double

The minimum value to be generated, inclusive.

name

open override val name: String

The name of the scheme as shown to the user.

showTrailingZeroes

var showTrailingZeroes: Boolean

Whether to include trailing zeroes in the decimals.

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

deepCopy

open override fun deepCopy(retainUuid: Boolean): DecimalScheme

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.