intellij-randomness / com.fwdekker.randomness.string / StringSettings

StringSettings

data class StringSettings : Settings<StringSettings>

Contains settings for generating random strings.

Constructors

<init>

StringSettings(minLength: Int = DEFAULT_MIN_LENGTH, maxLength: Int = DEFAULT_MAX_LENGTH, enclosure: String = DEFAULT_ENCLOSURE, capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, alphabets: MutableSet<Alphabet> = mutableSetOf(Alphabet.ALPHABET, Alphabet.DIGITS))

Contains settings for generating random strings.

Properties

alphabets

var alphabets: MutableSet<Alphabet>

The alphabets to be used for generating strings.

capitalization

var capitalization: CapitalizationMode

The capitalization mode of the generated string.

enclosure

var enclosure: String

The string that encloses the generated string on both sides.

maxLength

var maxLength: Int

The maximum length of the generated string, inclusive.

minLength

var minLength: Int

The minimum length of the generated string, inclusive.

Functions

copyState

fun copyState(): StringSettings

Returns a shallow copy of this instance.

getState

fun getState(): StringSettings

Returns this.

loadState

fun loadState(state: StringSettings): Unit

Copies the fields of state to this.

Companion Object Properties

default

val default: StringSettings

The persistent StringSettings instance.

DEFAULT_CAPITALIZATION

val DEFAULT_CAPITALIZATION: CapitalizationMode

The default value of the capitalization field.

DEFAULT_ENCLOSURE

const val DEFAULT_ENCLOSURE: String

The default value of the enclosure field.

DEFAULT_MAX_LENGTH

const val DEFAULT_MAX_LENGTH: Int

The default value of the maxLength field.

DEFAULT_MIN_LENGTH

const val DEFAULT_MIN_LENGTH: Int

The default value of the minLength field.