Class LogicalLocation

java.lang.Object
se.bjurr.violations.lib.model.generated.sarif.LogicalLocation

public class LogicalLocation extends Object
A logical location of a construct that produced a result.
  • Constructor Details

    • LogicalLocation

      public LogicalLocation()
  • Method Details

    • getName

      public 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(String name)
      Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.
    • withName

      public LogicalLocation withName(String name)
    • getIndex

      public Integer getIndex()
      The index within the logical locations array.
    • setIndex

      public void setIndex(Integer index)
      The index within the logical locations array.
    • withIndex

      public LogicalLocation withIndex(Integer index)
    • getFullyQualifiedName

      public String getFullyQualifiedName()
      The human-readable fully qualified name of the logical location.
    • setFullyQualifiedName

      public void setFullyQualifiedName(String fullyQualifiedName)
      The human-readable fully qualified name of the logical location.
    • withFullyQualifiedName

      public LogicalLocation withFullyQualifiedName(String fullyQualifiedName)
    • getDecoratedName

      public 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(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.
    • withDecoratedName

      public LogicalLocation withDecoratedName(String decoratedName)
    • getParentIndex

      public 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(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.
    • withParentIndex

      public LogicalLocation withParentIndex(Integer parentIndex)
    • getKind

      public 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(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.
    • withKind

      public LogicalLocation withKind(String kind)
    • 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.
    • withProperties

      public LogicalLocation withProperties(PropertyBag properties)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object