Randomness/com.fwdekker.randomness.integer/IntegerScheme

IntegerScheme

data class IntegerScheme(var minValue: Long = DEFAULT_MIN_VALUE, var maxValue: Long = DEFAULT_MAX_VALUE, var base: Int = DEFAULT_BASE, var isUppercase: Boolean = DEFAULT_IS_UPPERCASE, var groupingSeparatorEnabled: Boolean = DEFAULT_GROUPING_SEPARATOR_ENABLED, var groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, val fixedLengthDecorator: FixedLengthDecorator = DEFAULT_FIXED_LENGTH_DECORATOR, val affixDecorator: AffixDecorator = DEFAULT_AFFIX_DECORATOR, val arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR) : Scheme(source)

Contains settings for generating random integers.

Constructors

IntegerScheme

constructor(minValue: Long = DEFAULT_MIN_VALUE, maxValue: Long = DEFAULT_MAX_VALUE, base: Int = DEFAULT_BASE, isUppercase: Boolean = DEFAULT_IS_UPPERCASE, groupingSeparatorEnabled: Boolean = DEFAULT_GROUPING_SEPARATOR_ENABLED, groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, fixedLengthDecorator: FixedLengthDecorator = DEFAULT_FIXED_LENGTH_DECORATOR, 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.

base

var base: Int

The base the generated value should be displayed in.

decorators

open override val decorators: List<DecoratorScheme>

Additional logic that determines how strings are generated.

fixedLengthDecorator

val fixedLengthDecorator: FixedLengthDecorator

Settings that determine whether the output should be fixed to a specific length.

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 applied.

isUppercase

var isUppercase: Boolean

true if and only if all letters are uppercase.

maxValue

var maxValue: Long

The maximum value to be generated, inclusive.

minValue

var minValue: Long

The minimum value to be generated, inclusive.

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.

Functions

deepCopy

open override fun deepCopy(retainUuid: Boolean): IntegerScheme

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 random formatted integers from minValue (inclusive) to maxValue (inclusive).

longToString

private fun longToString(value: Long): String

Returns a nicely formatted representation of value.

randomLong

private fun randomLong(from: Long, until: Long): Long

Returns a random long in the range from from (inclusive) to until (inclusive) without causing overflow.