Randomness v2.7.6/com.fwdekker.randomness.string/StringScheme

StringScheme

data class StringScheme(var myName: String = DEFAULT_NAME, var minLength: Int = DEFAULT_MIN_LENGTH, var maxLength: Int = DEFAULT_MAX_LENGTH, var enclosure: String = DEFAULT_ENCLOSURE, var capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, var prefix: String = DEFAULT_PREFIX, var suffix: String = DEFAULT_SUFFIX, var serializedSymbolSets: Map<String, String> = DEFAULT_SYMBOL_SETS.toMap(), var serializedActiveSymbolSets: Map<String, String> = DEFAULT_ACTIVE_SYMBOL_SETS.toMap(), var excludeLookAlikeSymbols: Boolean = DEFAULT_EXCLUDE_LOOK_ALIKE_SYMBOLS) : Scheme<StringScheme> (source)

Contains settings for generating random strings.

Constructors

StringScheme

fun StringScheme(myName: String = DEFAULT_NAME, minLength: Int = DEFAULT_MIN_LENGTH, maxLength: Int = DEFAULT_MAX_LENGTH, enclosure: String = DEFAULT_ENCLOSURE, capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, prefix: String = DEFAULT_PREFIX, suffix: String = DEFAULT_SUFFIX, serializedSymbolSets: Map<String, String> = DEFAULT_SYMBOL_SETS.toMap(), serializedActiveSymbolSets: Map<String, String> = DEFAULT_ACTIVE_SYMBOL_SETS.toMap(), excludeLookAlikeSymbols: Boolean = DEFAULT_EXCLUDE_LOOK_ALIKE_SYMBOLS)

Types

Companion

object Companion

Holds constants.

Functions

copyAs

open override fun copyAs(name: String): StringScheme

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

copyFrom

open override fun copyFrom(other: StringScheme)

Shallowly copies the state of other into this.

getDisplayName

@NotNull

@Nls

open fun getDisplayName(): @NotNull @Nls String

getName

open override fun getName(): String

Same as myName.

Properties

activeSymbolSetList

var activeSymbolSetList: Collection<SymbolSet>

A list view of the SymbolSet objects described by activeSymbolSets.

activeSymbolSets

var activeSymbolSets: Map<String, String>

Same as activeSymbolSets, except that serialized emoji have been deserialized.

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.

excludeLookAlikeSymbols

var excludeLookAlikeSymbols: Boolean

Whether the symbols in SymbolSet.lookAlikeCharacters should be excluded.

maxLength

var maxLength: Int

The maximum length of the generated string, inclusive.

minLength

var minLength: Int

The minimum length of the generated string, inclusive.

myName

open override var myName: String

The name of the scheme.

prefix

var prefix: String

The string to prepend to the generated value.

serializedActiveSymbolSets

var serializedActiveSymbolSets: Map<String, String>

The symbol sets that are actually used for generating strings; a subset of symbolSets. Emoji have been serialized for compatibility with JetBrains' serializer.

serializedSymbolSets