Randomness v3.0.0/com.fwdekker.randomness.datetime/DateTimeScheme

DateTimeScheme

data class DateTimeScheme(var minDateTime: Long = DEFAULT_MIN_DATE_TIME, var maxDateTime: Long = DEFAULT_MAX_DATE_TIME, var pattern: String = DEFAULT_PATTERN, val arrayDecorator: ArrayDecorator = ArrayDecorator()) : Scheme(source)

Contains settings for generating random date-times.

Constructors

DateTimeScheme

constructor(minDateTime: Long = DEFAULT_MIN_DATE_TIME, maxDateTime: Long = DEFAULT_MAX_DATE_TIME, pattern: String = DEFAULT_PATTERN, arrayDecorator: ArrayDecorator = ArrayDecorator())

Types

Companion

object Companion

Holds constants.

Properties

arrayDecorator

val arrayDecorator: ArrayDecorator

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

decorators

open override val decorators: List<ArrayDecorator>

Additional logic that determines how strings are generated.

maxDateTime

var maxDateTime: Long

The maximum date-time as a millisecond epoch to be generated, inclusive.

minDateTime

var minDateTime: Long

The minimum date-time as a millisecond epoch to be generated, inclusive.

name

open override val name: String

The name of the scheme as shown to the user.

pattern

var pattern: String

The pattern in which the generated date-time is formatted.

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): DateTimeScheme

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.