modulecheck-reporting:sarif/modulecheck.reporting.sarif/LogicalLocation

LogicalLocation

@JsonClass(generateAdapter = true)

data class LogicalLocation(@Json(name = "decoratedName") val decoratedName: String? = null, @Json(name = "fullyQualifiedName") val fullyQualifiedName: String? = null, @Json(name = "index") val index: Int? = null, @Json(name = "kind") val kind: String? = null, @Json(name = "name") val name: String? = null, @Json(name = "parentIndex") val parentIndex: Int? = null, @Json(name = "properties") val properties: PropertyBag? = null)(source)

A logical location of a construct that produced a result.

Since

0.12.0

Constructors

LogicalLocation

constructor(@Json(name = "decoratedName") decoratedName: String? = null, @Json(name = "fullyQualifiedName") fullyQualifiedName: String? = null, @Json(name = "index") index: Int? = null, @Json(name = "kind") kind: String? = null, @Json(name = "name") name: String? = null, @Json(name = "parentIndex") parentIndex: Int? = null, @Json(name = "properties") properties: PropertyBag? = null)

Properties

decoratedName

val decoratedName: String? = null

The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

fullyQualifiedName

val fullyQualifiedName: String? = null

The human-readable fully qualified name of the logical location.

index

val index: Int? = null

The index within the logical locations array.

kind

val kind: String? = null

The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.

name

val name: String? = null

Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

parentIndex

val parentIndex: Int? = null

Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

properties

val properties: PropertyBag? = null

Key/value pairs that provide additional information about the logical location.