Address (com.contrastsecurity:java-sarif 1.0 API)

java.lang.Object
- com.contrastsecurity.sarif.Address

```
public class Address
extends Object
```
A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

Constructor Summary

Constructors
Constructor and Description

Address()

Constructors
Constructor and Description
`Address()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Integer`	`getAbsoluteAddress()` The address expressed as a byte offset from the start of the addressable region.
`String`	`getFullyQualifiedName()` A human-readable fully qualified name that is associated with the address.
`Integer`	`getIndex()` The index within run.addresses of the cached object for this address.
`String`	`getKind()` An open-ended string that identifies the address kind.
`Integer`	`getLength()` The number of bytes in this range of addresses.
`String`	`getName()` A name that is associated with the address, e.g., '.text'.
`Integer`	`getOffsetFromParent()` The byte offset of this address from the absolute or relative address of the parent object.
`Integer`	`getParentIndex()` The index within run.addresses of the parent object.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`Integer`	`getRelativeAddress()` The address expressed as a byte offset from the absolute address of the top-most parent object.
`int`	`hashCode()`
`void`	`setAbsoluteAddress(Integer absoluteAddress)` The address expressed as a byte offset from the start of the addressable region.
`void`	`setFullyQualifiedName(String fullyQualifiedName)` A human-readable fully qualified name that is associated with the address.
`void`	`setIndex(Integer index)` The index within run.addresses of the cached object for this address.
`void`	`setKind(String kind)` An open-ended string that identifies the address kind.
`void`	`setLength(Integer length)` The number of bytes in this range of addresses.
`void`	`setName(String name)` A name that is associated with the address, e.g., '.text'.
`void`	`setOffsetFromParent(Integer offsetFromParent)` The byte offset of this address from the absolute or relative address of the parent object.
`void`	`setParentIndex(Integer parentIndex)` The index within run.addresses of the parent object.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setRelativeAddress(Integer relativeAddress)` The address expressed as a byte offset from the absolute address of the top-most parent object.
`String`	`toString()`
`Address`	`withAbsoluteAddress(Integer absoluteAddress)`
`Address`	`withFullyQualifiedName(String fullyQualifiedName)`
`Address`	`withIndex(Integer index)`
`Address`	`withKind(String kind)`
`Address`	`withLength(Integer length)`
`Address`	`withName(String name)`
`Address`	`withOffsetFromParent(Integer offsetFromParent)`
`Address`	`withParentIndex(Integer parentIndex)`
`Address`	`withProperties(PropertyBag properties)`
`Address`	`withRelativeAddress(Integer relativeAddress)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Address
```
public Address()
```
- Method Detail
  - getAbsoluteAddress
```
public Integer getAbsoluteAddress()
```
    The address expressed as a byte offset from the start of the addressable region.
  - setAbsoluteAddress
```
public void setAbsoluteAddress(Integer absoluteAddress)
```
    The address expressed as a byte offset from the start of the addressable region.
  - withAbsoluteAddress
```
public Address withAbsoluteAddress(Integer absoluteAddress)
```
  - getRelativeAddress
```
public Integer getRelativeAddress()
```
    The address expressed as a byte offset from the absolute address of the top-most parent object.
  - setRelativeAddress
```
public void setRelativeAddress(Integer relativeAddress)
```
    The address expressed as a byte offset from the absolute address of the top-most parent object.
  - withRelativeAddress
```
public Address withRelativeAddress(Integer relativeAddress)
```
  - getLength
```
public Integer getLength()
```
    The number of bytes in this range of addresses.
  - setLength
```
public void setLength(Integer length)
```
    The number of bytes in this range of addresses.
  - withLength
```
public Address withLength(Integer length)
```
  - getKind
```
public String getKind()
```
    An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.
  - setKind
```
public void setKind(String kind)
```
    An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.
  - withKind
```
public Address withKind(String kind)
```
  - getName
```
public String getName()
```
    A name that is associated with the address, e.g., '.text'.
  - setName
```
public void setName(String name)
```
    A name that is associated with the address, e.g., '.text'.
  - withName
```
public Address withName(String name)
```
  - getFullyQualifiedName
```
public String getFullyQualifiedName()
```
    A human-readable fully qualified name that is associated with the address.
  - setFullyQualifiedName
```
public void setFullyQualifiedName(String fullyQualifiedName)
```
    A human-readable fully qualified name that is associated with the address.
  - withFullyQualifiedName
```
public Address withFullyQualifiedName(String fullyQualifiedName)
```
  - getOffsetFromParent
```
public Integer getOffsetFromParent()
```
    The byte offset of this address from the absolute or relative address of the parent object.
  - setOffsetFromParent
```
public void setOffsetFromParent(Integer offsetFromParent)
```
    The byte offset of this address from the absolute or relative address of the parent object.
  - withOffsetFromParent
```
public Address withOffsetFromParent(Integer offsetFromParent)
```
  - getIndex
```
public Integer getIndex()
```
    The index within run.addresses of the cached object for this address.
  - setIndex
```
public void setIndex(Integer index)
```
    The index within run.addresses of the cached object for this address.
  - withIndex
```
public Address withIndex(Integer index)
```
  - getParentIndex
```
public Integer getParentIndex()
```
    The index within run.addresses of the parent object.
  - setParentIndex
```
public void setParentIndex(Integer parentIndex)
```
    The index within run.addresses of the parent object.
  - withParentIndex
```
public Address withParentIndex(Integer parentIndex)
```
  - 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 Address 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

Class Address

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Address

Method Detail

getAbsoluteAddress

setAbsoluteAddress

withAbsoluteAddress

getRelativeAddress

setRelativeAddress

withRelativeAddress

getLength

setLength

withLength

getKind

setKind

withKind

getName

setName

withName

getFullyQualifiedName

setFullyQualifiedName

withFullyQualifiedName

getOffsetFromParent

setOffsetFromParent

withOffsetFromParent

getIndex

setIndex

withIndex

getParentIndex

setParentIndex

withParentIndex

getProperties

setProperties

withProperties

toString

hashCode

equals