KSLCore/ksl.app.results.batchreports/BatchReportsWriter/FileHandlingPolicy

FileHandlingPolicy

enum FileHandlingPolicy : Enum<BatchReportsWriter.FileHandlingPolicy> (source)

Policy applied at write time when a destination file already exists for the target stem. Picked by the user via the reports tab's File-handling group; passed through to both renderItemSummary and renderBatchSummary on every Generate.

Entries

OVERWRITE

Default — write over any existing file with the same stem.

SKIP_IF_EXISTS

Don't write; return an empty WriteOutcome with skipped=true when any of the target paths already exists. Lets the user Generate selectively without disturbing files they've kept.

APPEND_TIMESTAMP

Append a _yyyy-MM-dd_HHmmss suffix to the stem so the new file lives alongside any prior versions. Useful when comparing report variants.

Properties

entries

val entries: EnumEntries<BatchReportsWriter.FileHandlingPolicy>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

valueOf

fun valueOf(value: String): BatchReportsWriter.FileHandlingPolicy

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<BatchReportsWriter.FileHandlingPolicy>

Returns an array containing the constants of this enum type, in the order they're declared.