WordScheme

data class WordScheme(myName: String, minLength: Int, maxLength: Int, enclosure: String, capitalization: CapitalizationMode, bundledDictionaryFiles: MutableSet<String>, activeBundledDictionaryFiles: MutableSet<String>, userDictionaryFiles: MutableSet<String>, activeUserDictionaryFiles: MutableSet<String>) : Scheme<WordScheme>

Contains settings for generating random words.

Constructors

WordScheme

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

Companion

object Companion

Holds constants.

Functions

copyAs

open override fun copyAs(name: String): WordScheme

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

copyFrom

open override fun copyFrom(other: WordScheme)

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

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.

capitalization

var capitalization: CapitalizationMode

The way in which the generated word should be capitalized.

enclosure

var enclosure: String

The string that encloses the generated word on both sides.

maxLength

var maxLength: Int

The maximum length of the generated word, inclusive.

minLength

var minLength: Int

The minimum length of the generated word, inclusive.

myName

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

jvm source

WordScheme

See also

Constructors

Types

Functions

Properties

Sources