Randomness/com.fwdekker.randomness.string/StringScheme

StringScheme

data class StringScheme(var pattern: String = DEFAULT_PATTERN, var isRegex: Boolean = DEFAULT_IS_REGEX, var isNonMatching: Boolean = DEFAULT_IS_NON_MATCHING, var capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, var removeLookAlikeSymbols: Boolean = DEFAULT_REMOVE_LOOK_ALIKE_SYMBOLS, val arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR) : Scheme(source)

Contains settings for generating random strings.

Constructors

StringScheme

constructor(pattern: String = DEFAULT_PATTERN, isRegex: Boolean = DEFAULT_IS_REGEX, isNonMatching: Boolean = DEFAULT_IS_NON_MATCHING, capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, removeLookAlikeSymbols: Boolean = DEFAULT_REMOVE_LOOK_ALIKE_SYMBOLS, arrayDecorator: ArrayDecorator = DEFAULT_ARRAY_DECORATOR)

Types

Companion

object Companion

Holds constants.

Properties

arrayDecorator

val arrayDecorator: ArrayDecorator

Settings that determine whether the output should be an array of values.

capitalization

var capitalization: CapitalizationMode

The capitalization mode of the generated string.

decorators

open override val decorators: List<ArrayDecorator>

Additional logic that determines how strings are generated.

isNonMatching

var isNonMatching: Boolean

true if and only if non-matching values should be generated if isRegex is true.

isRegex

var isRegex: Boolean

true if and only if pattern should be interpreted as a regex.

name

open override val name: String

The name of the scheme as shown to the user.

pattern

var pattern: String

The regex-like pattern according to which the string is generated.

removeLookAlikeSymbols

var removeLookAlikeSymbols: Boolean

Whether the symbols in LOOK_ALIKE_CHARACTERS should be removed.

typeIcon

open override val typeIcon: TypeIcon

The icon signifying the type of data represented by this scheme, ignoring its decorators, or null if this scheme does not represent any kind of data, as is the case for DecoratorSchemes.

Functions

deepCopy

open override fun deepCopy(retainUuid: Boolean): StringScheme

Returns a deep copy, retaining the uuid if and only if retainUuid is true.

doValidate

open override fun doValidate(): String?

Validates the state, and indicates whether and why it is invalid.

generateUndecoratedStrings

protected open override fun generateUndecoratedStrings(count: Int): List<String>

Returns count strings of random alphanumerical characters.

isSimple

fun isSimple(): Boolean

Returns true if and only if this scheme does not use any regex functionality beyond escape characters.