Properties

io.shiftleft.codepropertygraph.generated.nodes.File.Properties
object Properties

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Properties.type

Members list

Value members

Concrete fields

val Code: SinglePropertyKey[String]

This field holds the code snippet that the node represents.

This field holds the code snippet that the node represents.

Attributes

val ColumnNumber: OptionalPropertyKey[Int]

This optional fields provides the column number of the program construct represented by the node.

This optional fields provides the column number of the program construct represented by the node.

Attributes

val Content: SinglePropertyKey[String]

Certain files, e.g., configuration files, may be included in the CPG as-is. For such files, the CONTENT field contains the files content.

Certain files, e.g., configuration files, may be included in the CPG as-is. For such files, the CONTENT field contains the files content.

Attributes

val Hash: OptionalPropertyKey[String]

This property contains a hash value in the form of a string. Hashes can be used to summarize data, e.g., to summarize the contents of source files or sub graphs. Such summaries are useful to determine whether code has already been analyzed in incremental analysis pipelines. This property is optional to allow its calculation to be deferred or skipped if the hash is not needed.

This property contains a hash value in the form of a string. Hashes can be used to summarize data, e.g., to summarize the contents of source files or sub graphs. Such summaries are useful to determine whether code has already been analyzed in incremental analysis pipelines. This property is optional to allow its calculation to be deferred or skipped if the hash is not needed.

Attributes

val LineNumber: OptionalPropertyKey[Int]

This optional field provides the line number of the program construct represented by the node.

This optional field provides the line number of the program construct represented by the node.

Attributes

val Name: SinglePropertyKey[String]

Name of represented object, e.g., method name (e.g. "run")

Name of represented object, e.g., method name (e.g. "run")

Attributes

val Offset: OptionalPropertyKey[Int]

Start offset into the CONTENT property of the corresponding FILE node. The offset is such that parts of the content can easily be accessed via content.substring(offset, offsetEnd). This means that the offset must be measured in utf16 encoding (i.e. neither in characters/codeunits nor in byte-offsets into a utf8 encoding). E.g. for METHOD nodes this start offset points to the start of the methods source code in the string holding the source code of the entire file.

Start offset into the CONTENT property of the corresponding FILE node. The offset is such that parts of the content can easily be accessed via content.substring(offset, offsetEnd). This means that the offset must be measured in utf16 encoding (i.e. neither in characters/codeunits nor in byte-offsets into a utf8 encoding). E.g. for METHOD nodes this start offset points to the start of the methods source code in the string holding the source code of the entire file.

Attributes

val OffsetEnd: OptionalPropertyKey[Int]

End offset (exclusive) into the CONTENT property of the corresponding FILE node. See OFFSET documentation for finer details. E.g. for METHOD nodes this end offset points to the first code position which is not part of the method.

End offset (exclusive) into the CONTENT property of the corresponding FILE node. See OFFSET documentation for finer details. E.g. for METHOD nodes this end offset points to the first code position which is not part of the method.

Attributes

val Order: SinglePropertyKey[Int]

This integer indicates the position of the node among its siblings in the AST. The left-most child has an order of 0.

This integer indicates the position of the node among its siblings in the AST. The left-most child has an order of 0.

Attributes