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

StringSettings

data class StringSettings : Settings<StringSettings>

Contains settings for generating random strings.

Constructors

StringSettings(minLength: Int = DEFAULT_MIN_LENGTH, maxLength: Int = DEFAULT_MAX_LENGTH, enclosure: String = DEFAULT_ENCLOSURE, capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, symbolSets: Map<String, String> = DEFAULT_SYMBOL_SETS.toMap(), activeSymbolSets: Map<String, String> = DEFAULT_ACTIVE_SYMBOL_SETS.toMap())

Contains settings for generating random strings.

Properties

activeSymbolSetList	`var activeSymbolSetList: Collection<SymbolSet>` A list view of the `SymbolSet` objects described by activeSymbolSets.
activeSymbolSets	`var activeSymbolSets: Map<String, String>` The symbol sets that are actually used for generating strings; a subset of symbolSets.
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.
symbolSetList	`var symbolSetList: Collection<SymbolSet>` A list view of the `SymbolSet` objects described by symbolSets.
symbolSets	`var symbolSets: Map<String, String>` The symbol sets that are available for generating strings.

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_ACTIVE_SYMBOL_SETS	`val DEFAULT_ACTIVE_SYMBOL_SETS: Map<String, String>` The default value of the activeSymbolSets field.
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.
DEFAULT_SYMBOL_SETS	`val DEFAULT_SYMBOL_SETS: Map<String, String>` The default value of the symbolSets field.