Randomness v2.7.6/com.fwdekker.randomness.integer/IntegerScheme

IntegerScheme

data class IntegerScheme(var myName: String = DEFAULT_NAME, var minValue: Long = DEFAULT_MIN_VALUE, var maxValue: Long = DEFAULT_MAX_VALUE, var base: Int = DEFAULT_BASE, var groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, var capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, var prefix: String = DEFAULT_PREFIX, var suffix: String = DEFAULT_SUFFIX) : Scheme<IntegerScheme> (source)

Contains settings for generating random integers.

See also

IntegerInsertAction

IntegerSettings

Constructors

fun IntegerScheme(myName: String = DEFAULT_NAME, minValue: Long = DEFAULT_MIN_VALUE, maxValue: Long = DEFAULT_MAX_VALUE, base: Int = DEFAULT_BASE, groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, prefix: String = DEFAULT_PREFIX, suffix: String = DEFAULT_SUFFIX)

Types

object Companion

Holds constants.

Functions

open override fun copyAs(name: String): IntegerScheme

Returns a copy of this scheme that has the given name.

open override fun copyFrom(other: IntegerScheme)

Shallowly copies the state of other into this.

@NotNull

@Nls

open fun getDisplayName(): @NotNull @Nls String

open override fun getName(): String

Same as myName.

safeSetGroupingSeparator

fun safeSetGroupingSeparator(groupingSeparator: String?)

Sets the grouping separator safely to ensure that exactly one character is set.

Properties

var base: Int

The base the generated value should be displayed in.

var capitalization: CapitalizationMode

The capitalization mode of the generated integer, applicable for bases higher than 10.

groupingSeparator

var groupingSeparator: String

The character that should separate groups.

var maxValue: Long

The maximum value to be generated, inclusive.

var minValue: Long

The minimum value to be generated, inclusive.

open override var myName: String

The name of the scheme.

var prefix: String

The string to prepend to the generated value.

var suffix: String

The string to append to the generated value.