de.jcup.sarif_2_1_0.model

Class LogicalLocation

java.lang.Object

de.jcup.sarif_2_1_0.model.LogicalLocation

public class LogicalLocation
extends java.lang.Object

A logical location of a construct that produced a result.

Constructor Summary

Constructors

Constructor and Description
LogicalLocation()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.lang.String	getDecoratedName() 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.
java.lang.String	getFullyQualifiedName() The human-readable fully qualified name of the logical location.
java.lang.Integer	getIndex() The index within the logical locations array.
java.lang.String	getKind() The type of construct this logical location component refers to.
java.lang.String	getName() Identifies the construct in which the result occurred.
java.lang.Integer	getParentIndex() Identifies the index of the immediate parent of the construct in which the result was detected.
PropertyBag	getProperties() Key/value pairs that provide additional information about the object.
int	hashCode()
void	setDecoratedName(java.lang.String decoratedName) 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.
void	setFullyQualifiedName(java.lang.String fullyQualifiedName) The human-readable fully qualified name of the logical location.
void	setIndex(java.lang.Integer index) The index within the logical locations array.
void	setKind(java.lang.String kind) The type of construct this logical location component refers to.
void	setName(java.lang.String name) Identifies the construct in which the result occurred.
void	setParentIndex(java.lang.Integer parentIndex) Identifies the index of the immediate parent of the construct in which the result was detected.
void	setProperties(PropertyBag properties) Key/value pairs that provide additional information about the object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LogicalLocation

public LogicalLocation()

Method Detail

getName

public java.lang.String getName()

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

setName

public void setName(java.lang.String name)

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

getIndex

public java.lang.Integer getIndex()

The index within the logical locations array.

setIndex

public void setIndex(java.lang.Integer index)

The index within the logical locations array.

getFullyQualifiedName

public java.lang.String getFullyQualifiedName()

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

setFullyQualifiedName

public void setFullyQualifiedName(java.lang.String fullyQualifiedName)

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

getDecoratedName

public java.lang.String getDecoratedName()

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.

setDecoratedName

public void setDecoratedName(java.lang.String decoratedName)

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.

getParentIndex

public java.lang.Integer getParentIndex()

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.

setParentIndex

public void setParentIndex(java.lang.Integer parentIndex)

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.

getKind

public java.lang.String getKind()

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.

setKind

public void setKind(java.lang.String kind)

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.

getProperties

public PropertyBag getProperties()

Key/value pairs that provide additional information about the object.

setProperties

public void setProperties(PropertyBag properties)

Key/value pairs that provide additional information about the object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object