stig-engine/com.stigway.engine.diagram/StigSpriteIcon

StigSpriteIcon

enum StigSpriteIcon : Enum<StigSpriteIcon>

The set of stig-icons-* sprite IDs the diagram pipeline references.

Each entry must have a corresponding <symbol id="..."> in stig-icons.svg, which is generated from pinned Iconify JSON packages by StigIconSpriteGenerator. The round-trip is checked at build time by com.stigway.gradle.support.StigSpriteIconValidator — a missing entry produces an actionable error message pointing at GenerateStigIcons.kt + gradle-update.sh.

Adding a new sprite is a three-step process:

Add a new entry to this enum with the canonical stig-icons-<mdi-name> ID.
Add the same sprite id and Iconify <set>:<name> reference to STIG_ICONS in GenerateStigIcons.kt.
Run ./gradlew :stig-gradle-plugin:stigGenerateStigIcons (or ./scripts/gradle-update.sh) to regenerate the sprite.

Entries

VIEWPOINT_REQUIREMENTS

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<StigSpriteIcon>

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

name

val name: String

ordinal

val ordinal: Int

spriteId

val spriteId: String

Functions

valueOf

fun valueOf(value: String): StigSpriteIcon

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

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