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

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

```
public class Location
extends Object
```
A location within a programming artifact.

Constructor Summary

Constructors
Constructor and Description

Location()

Constructors
Constructor and Description
`Location()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Set<Region>`	`getAnnotations()` A set of regions relevant to the location.
`Integer`	`getId()` Value that distinguishes this location from all other locations within a single result object.
`Set<LogicalLocation>`	`getLogicalLocations()` The logical locations associated with the result.
`Message`	`getMessage()` Encapsulates a message intended to be read by the end user.
`PhysicalLocation`	`getPhysicalLocation()` A physical location relevant to a result.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`Set<LocationRelationship>`	`getRelationships()` An array of objects that describe relationships between this location and others.
`int`	`hashCode()`
`void`	`setAnnotations(Set<Region> annotations)` A set of regions relevant to the location.
`void`	`setId(Integer id)` Value that distinguishes this location from all other locations within a single result object.
`void`	`setLogicalLocations(Set<LogicalLocation> logicalLocations)` The logical locations associated with the result.
`void`	`setMessage(Message message)` Encapsulates a message intended to be read by the end user.
`void`	`setPhysicalLocation(PhysicalLocation physicalLocation)` A physical location relevant to a result.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setRelationships(Set<LocationRelationship> relationships)` An array of objects that describe relationships between this location and others.
`String`	`toString()`
`Location`	`withAnnotations(Set<Region> annotations)`
`Location`	`withId(Integer id)`
`Location`	`withLogicalLocations(Set<LogicalLocation> logicalLocations)`
`Location`	`withMessage(Message message)`
`Location`	`withPhysicalLocation(PhysicalLocation physicalLocation)`
`Location`	`withProperties(PropertyBag properties)`
`Location`	`withRelationships(Set<LocationRelationship> relationships)`

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

- Constructor Detail
  - Location
```
public Location()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Value that distinguishes this location from all other locations within a single result object.
  - setId
```
public void setId(Integer id)
```
    Value that distinguishes this location from all other locations within a single result object.
  - withId
```
public Location withId(Integer id)
```
  - getPhysicalLocation
```
public PhysicalLocation getPhysicalLocation()
```
    A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.
  - setPhysicalLocation
```
public void setPhysicalLocation(PhysicalLocation physicalLocation)
```
    A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.
  - withPhysicalLocation
```
public Location withPhysicalLocation(PhysicalLocation physicalLocation)
```
  - getLogicalLocations
```
public Set<LogicalLocation> getLogicalLocations()
```
    The logical locations associated with the result.
  - setLogicalLocations
```
public void setLogicalLocations(Set<LogicalLocation> logicalLocations)
```
    The logical locations associated with the result.
  - withLogicalLocations
```
public Location withLogicalLocations(Set<LogicalLocation> logicalLocations)
```
  - getMessage
```
public Message getMessage()
```
    Encapsulates a message intended to be read by the end user.
  - setMessage
```
public void setMessage(Message message)
```
    Encapsulates a message intended to be read by the end user.
  - withMessage
```
public Location withMessage(Message message)
```
  - getAnnotations
```
public Set<Region> getAnnotations()
```
    A set of regions relevant to the location.
  - setAnnotations
```
public void setAnnotations(Set<Region> annotations)
```
    A set of regions relevant to the location.
  - withAnnotations
```
public Location withAnnotations(Set<Region> annotations)
```
  - getRelationships
```
public Set<LocationRelationship> getRelationships()
```
    An array of objects that describe relationships between this location and others.
  - setRelationships
```
public void setRelationships(Set<LocationRelationship> relationships)
```
    An array of objects that describe relationships between this location and others.
  - withRelationships
```
public Location withRelationships(Set<LocationRelationship> relationships)
```
  - 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 Location 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 Location

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Location

Method Detail

getId

setId

withId

getPhysicalLocation

setPhysicalLocation

withPhysicalLocation

getLogicalLocations

setLogicalLocations

withLogicalLocations

getMessage

setMessage

withMessage

getAnnotations

setAnnotations

withAnnotations

getRelationships

setRelationships

withRelationships

getProperties

setProperties

withProperties

toString

hashCode

equals