intellij-randomness / com.fwdekker.randomness.word / WordScheme

WordScheme

data class WordScheme : Scheme<WordScheme>

Contains settings for generating random words.

Constructors

<init>

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())

Contains settings for generating random words.

Properties

activeBundledDictionaries

var activeBundledDictionaries: Set<BundledDictionary>

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<UserDictionary>

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<BundledDictionary>

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

var myName: String

The name of the scheme.

userDictionaries

var userDictionaries: Set<UserDictionary>

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.

Functions

copyAs

fun copyAs(name: String): WordScheme

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

copyFrom

fun copyFrom(other: WordScheme): Unit

Shallowly copies the state of other into this.

Inherited Functions

getName

open fun getName(): String

Same as myName.

Companion Object Properties

DEFAULT_ACTIVE_BUNDLED_DICTIONARY_FILES

val DEFAULT_ACTIVE_BUNDLED_DICTIONARY_FILES: Set<String>

The default value of the activeBundledDictionaryFiles field.

DEFAULT_ACTIVE_USER_DICTIONARY_FILES

val DEFAULT_ACTIVE_USER_DICTIONARY_FILES: Set<String>

The default value of the activeUserDictionaryFiles field.

DEFAULT_BUNDLED_DICTIONARY_FILES

val DEFAULT_BUNDLED_DICTIONARY_FILES: Set<String>

The default value of the bundledDictionaryFiles 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_USER_DICTIONARY_FILES

val DEFAULT_USER_DICTIONARY_FILES: Set<String>

The default value of the userDictionaryFiles field.