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

Constructors

Link copied to clipboard
constructor(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

Link copied to clipboard
object Companion

Holds constants.

Properties

Link copied to clipboard
var base: Int

The base the generated value should be displayed in.

Link copied to clipboard

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

Link copied to clipboard
var groupingSeparator: String

The character that should separate groups.

Link copied to clipboard
var maxValue: Long

The maximum value to be generated, inclusive.

Link copied to clipboard
var minValue: Long

The minimum value to be generated, inclusive.

Link copied to clipboard
open override var myName: String

The name of the scheme.

Link copied to clipboard
var prefix: String

The string to prepend to the generated value.

Link copied to clipboard
var suffix: String

The string to append to the generated value.

Functions

Link copied to clipboard
open override fun copyAs(name: String): IntegerScheme

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

Link copied to clipboard
open override fun copyFrom(other: IntegerScheme)

Shallowly copies the state of other into this.

Link copied to clipboard
@NotNull
@Nls
open fun getDisplayName(): @NotNull @Nls String
Link copied to clipboard
open override fun getName(): String

Same as myName.

Link copied to clipboard
fun safeSetGroupingSeparator(groupingSeparator: String?)

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