Landmark (Ariadne JSON Route Format 1.1 API)

java.lang.Object
- at.ac.ait.ariadne.routeformat.instruction.Landmark

All Implemented Interfaces:

Validatable
```
public class Landmark
extends Object
implements Validatable
```
A landmark, i.e. a salient object in the real world, that is used in navigation instructions.
In its minimal form it consists of a preposition and a Location, e.g. "before the public transport stop".

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors
Constructor and Description

Landmark()

Constructors
Constructor and Description
`Landmark()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Landmark`	`createMinimal(Constants.Preposition preposition, Location<?> location)`
`boolean`	`equals(Object obj)`
`Map<String,Object>`	`getAdditionalInfo()`
`Optional<Constants.RelativeDirection>`	`getDirection()`
`Location<?>`	`getLocation()`
`Constants.Preposition`	`getPreposition()`
`int`	`hashCode()`
`Landmark`	`setAdditionalInfo(Map<String,Object> additionalInfo)`
`Landmark`	`setDirection(Constants.RelativeDirection direction)`
`Landmark`	`setLocation(Location<?> location)`
`Landmark`	`setPreposition(Constants.Preposition preposition)`
`Landmark`	`shallowCopy()`
`String`	`toString()`
`void`	`validate()` Checks if the instance is in a valid / useful state.

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

- Constructor Detail
  - Landmark
```
public Landmark()
```
- Method Detail
  - getPreposition
```
public Constants.Preposition getPreposition()
```
    Returns:
    
    the preposition describing the location of the landmark relative to the route (i.e. the point on the route an Instruction is valid for)
  - getLocation
```
public Location<?> getLocation()
```
  - getDirection
```
public Optional<Constants.RelativeDirection> getDirection()
```
    Returns:
    
    the detailed direction in which the landmark lies relative to the route (i.e. the point on the route an Instruction is valid for)
  - getAdditionalInfo
```
public Map<String,Object> getAdditionalInfo()
```
  - setPreposition
```
public Landmark setPreposition(Constants.Preposition preposition)
```
  - setLocation
```
public Landmark setLocation(Location<?> location)
```
  - setDirection
```
public Landmark setDirection(Constants.RelativeDirection direction)
```
  - setAdditionalInfo
```
public Landmark setAdditionalInfo(Map<String,Object> additionalInfo)
```
  - createMinimal
```
public static Landmark createMinimal(Constants.Preposition preposition,
                                     Location<?> location)
```
  - shallowCopy
```
public Landmark shallowCopy()
```
  - validate
```
public void validate()
```
    Description copied from interface: Validatable
    
    Checks if the instance is in a valid / useful state. If this is not the case an IllegalArgumentException including a description of the invalid state is thrown.
    
    Specified by:
    
    validate in interface Validatable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Landmark

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Landmark

Method Detail

getPreposition

getLocation

getDirection

getAdditionalInfo

setPreposition

setLocation

setDirection

setAdditionalInfo

createMinimal

shallowCopy

validate

hashCode

equals

toString