IntegerScheme

data class IntegerScheme(myName: String, minValue: Long, maxValue: Long, base: Int, groupingSeparator: String, capitalization: CapitalizationMode, prefix: String, suffix: String) : Scheme<IntegerScheme>

Contains settings for generating random integers.

See also

Constructors

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

Companion
Link copied to clipboard
object Companion
Holds constants.

Functions

copyAs
Link copied to clipboard
open override fun copyAs(name: String): IntegerScheme
Returns a copy of this scheme that has the given name.
copyFrom
Link copied to clipboard
open override fun copyFrom(other: IntegerScheme)
Shallowly copies the state of other into this.
getDisplayName
Link copied to clipboard
@NotNull()
@Nls()
open fun getDisplayName(): @NotNull() @Nls() String
getName
Link copied to clipboard
open override fun getName(): String
Same as myName.
safeSetGroupingSeparator
Link copied to clipboard
fun safeSetGroupingSeparator(groupingSeparator: String?)
Sets the grouping separator safely to ensure that exactly one character is set.

Properties

base
Link copied to clipboard
var base: Int
The base the generated value should be displayed in.
capitalization
Link copied to clipboard
var capitalization: CapitalizationMode
The capitalization mode of the generated integer, applicable for bases higher than 10.
groupingSeparator
Link copied to clipboard
var groupingSeparator: String
The character that should separate groups.
maxValue
Link copied to clipboard
var maxValue: Long
The maximum value to be generated, inclusive.
minValue
Link copied to clipboard
var minValue: Long
The minimum value to be generated, inclusive.
myName
Link copied to clipboard
open override var myName: String
The name of the scheme.
prefix
Link copied to clipboard
var prefix: String
The string to prepend to the generated value.
suffix
Link copied to clipboard
var suffix: String
The string to append to the generated value.

Sources

jvm source
Link copied to clipboard