Randomness v2.7.5/com.fwdekker.randomness.word/WordScheme

WordScheme

data class WordScheme( 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 bundledDictionaryFiles: MutableSet<String> = DEFAULT_BUNDLED_DICTIONARY_FILES.toMutableSet(), var activeBundledDictionaryFiles: MutableSet<String> = DEFAULT_ACTIVE_BUNDLED_DICTIONARY_FILES.toMutableSet(), var userDictionaryFiles: MutableSet<String> = DEFAULT_USER_DICTIONARY_FILES.toMutableSet(), var activeUserDictionaryFiles: MutableSet<String> = DEFAULT_ACTIVE_USER_DICTIONARY_FILES.toMutableSet()) : Scheme<WordScheme>

Contains settings for generating random words.

See also

com.fwdekker.randomness.word.WordInsertAction

com.fwdekker.randomness.word.WordSettings

Constructors

fun WordScheme( myName: String = DEFAULT_NAME, minLength: Int = DEFAULT_MIN_LENGTH, maxLength: Int = DEFAULT_MAX_LENGTH, enclosure: String = DEFAULT_ENCLOSURE, capitalization: CapitalizationMode = DEFAULT_CAPITALIZATION, bundledDictionaryFiles: MutableSet<String> = DEFAULT_BUNDLED_DICTIONARY_FILES.toMutableSet(), activeBundledDictionaryFiles: MutableSet<String> = DEFAULT_ACTIVE_BUNDLED_DICTIONARY_FILES.toMutableSet(), userDictionaryFiles: MutableSet<String> = DEFAULT_USER_DICTIONARY_FILES.toMutableSet(), activeUserDictionaryFiles: MutableSet<String> = DEFAULT_ACTIVE_USER_DICTIONARY_FILES.toMutableSet())

Types

object Companion

Holds constants.

Functions

open override fun copyAs(name: String): WordScheme

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

open override fun copyFrom(other: WordScheme)

Shallowly copies the state of other into this.

@NotNull

@Nls

open fun getDisplayName(): @NotNull @Nls String

open override fun getName(): String

Same as myName.

Properties

activeBundledDictionaries

var activeBundledDictionaries: Set<DictionaryReference>

A mutable view of the filenames of the files in activeBundledDictionaryFiles.

activeBundledDictionaryFiles

var activeBundledDictionaryFiles: MutableSet<String>

The list of bundled dictionary files that are currently active; a subset of bundledDictionaryFiles.

activeUserDictionaries

var activeUserDictionaries: Set<DictionaryReference>

A mutable view of the filenames of the files in activeUserDictionaryFiles.

activeUserDictionaryFiles

var activeUserDictionaryFiles: MutableSet<String>

The list of user dictionary files that are currently active; a subset of userDictionaryFiles.

bundledDictionaries

var bundledDictionaries: Set<DictionaryReference>

A mutable view of the filenames of the files in bundledDictionaryFiles.

bundledDictionaryFiles

var bundledDictionaryFiles: MutableSet<String>

The list of all dictionary files provided by the plugin.

var capitalization: CapitalizationMode

The way in which the generated word should be capitalized.

var enclosure: String

The string that encloses the generated word on both sides.

var maxLength: Int

The maximum length of the generated word, inclusive.

var minLength: Int

The minimum length of the generated word, inclusive.

open override var myName: String

The name of the scheme.

userDictionaries

var userDictionaries: Set<DictionaryReference>

A mutable view of the filenames of the files in userDictionaryFiles.

userDictionaryFiles

var userDictionaryFiles: MutableSet<String>

The list of all dictionary files registered by the user.

Sources