IntermediateStop (Ariadne JSON Route Format 1.1 API)

java.lang.Object
- at.ac.ait.ariadne.routeformat.IntermediateStop

All Implemented Interfaces:

Validatable
```
public class IntermediateStop
extends Object
implements Validatable
```
An IntermediateStop represents a stop on a RouteSegment of interest to the user, e.g. a public transport stop where the public transport line the user is traveling with stops or a point of interest along a cycle route.
In its minimal form it consists of a Location.

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors
Constructor and Description

IntermediateStop()

Constructors
Constructor and Description
`IntermediateStop()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static IntermediateStop`	`createMinimal(Location<?> stop)`
`boolean`	`equals(Object obj)`
`Map<String,Object>`	`getAdditionalInfo()`
`Optional<String>`	`getEstimatedArrivalTime()`
`Optional<ZonedDateTime>`	`getEstimatedArrivalTimeAsZonedDateTime()`
`Optional<String>`	`getEstimatedDepartureTime()`
`Optional<ZonedDateTime>`	`getEstimatedDepartureTimeAsZonedDateTime()`
`Optional<String>`	`getPlannedArrivalTime()`
`Optional<ZonedDateTime>`	`getPlannedArrivalTimeAsZonedDateTime()`
`Optional<String>`	`getPlannedDepartureTime()`
`Optional<ZonedDateTime>`	`getPlannedDepartureTimeAsZonedDateTime()`
`Location<?>`	`getStop()`
`int`	`hashCode()`
`IntermediateStop`	`setAdditionalInfo(Map<String,Object> additionalInfo)`
`IntermediateStop`	`setEstimatedArrivalTime(String estimatedArrivalTime)`
`IntermediateStop`	`setEstimatedArrivalTime(ZonedDateTime estimatedArrivalTime)`
`IntermediateStop`	`setEstimatedDepartureTime(String estimatedDepartureTime)`
`IntermediateStop`	`setEstimatedDepartureTime(ZonedDateTime estimatedDepartureTime)`
`IntermediateStop`	`setPlannedArrivalTime(String plannedArrivalTime)`
`IntermediateStop`	`setPlannedArrivalTime(ZonedDateTime plannedArrivalTime)`
`IntermediateStop`	`setPlannedDepartureTime(String plannedDepartureTime)`
`IntermediateStop`	`setPlannedDepartureTime(ZonedDateTime plannedDepartureTime)`
`IntermediateStop`	`setStop(Location<?> stop)`
`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
- IntermediateStop
```
public IntermediateStop()
```

Method Detail

getStop
```
public Location<?> getStop()
```

getPlannedArrivalTime
```
public Optional<String> getPlannedArrivalTime()
```
Returns:

static time according to a time table

getPlannedArrivalTimeAsZonedDateTime
```
public Optional<ZonedDateTime> getPlannedArrivalTimeAsZonedDateTime()
```
Returns:

static time according to a time table

getPlannedDepartureTime
```
public Optional<String> getPlannedDepartureTime()
```
Returns:

static time according to a time table

getPlannedDepartureTimeAsZonedDateTime
```
public Optional<ZonedDateTime> getPlannedDepartureTimeAsZonedDateTime()
```
Returns:

static time according to a time table

getEstimatedArrivalTime
```
public Optional<String> getEstimatedArrivalTime()
```
Returns:

time estimated via real-time data

getEstimatedArrivalTimeAsZonedDateTime
```
public Optional<ZonedDateTime> getEstimatedArrivalTimeAsZonedDateTime()
```
Returns:

time estimated via real-time data

getEstimatedDepartureTime
```
public Optional<String> getEstimatedDepartureTime()
```
Returns:

time estimated via real-time data

getEstimatedDepartureTimeAsZonedDateTime
```
public Optional<ZonedDateTime> getEstimatedDepartureTimeAsZonedDateTime()
```
Returns:

time estimated via real-time data

getAdditionalInfo

public Map<String,Object> getAdditionalInfo()

setStop

public IntermediateStop setStop(Location<?> stop)

setPlannedArrivalTime

public IntermediateStop setPlannedArrivalTime(ZonedDateTime plannedArrivalTime)

setPlannedArrivalTime

public IntermediateStop setPlannedArrivalTime(String plannedArrivalTime)

setPlannedDepartureTime

public IntermediateStop setPlannedDepartureTime(ZonedDateTime plannedDepartureTime)

setPlannedDepartureTime

public IntermediateStop setPlannedDepartureTime(String plannedDepartureTime)

setEstimatedArrivalTime

public IntermediateStop setEstimatedArrivalTime(ZonedDateTime estimatedArrivalTime)

setEstimatedArrivalTime

public IntermediateStop setEstimatedArrivalTime(String estimatedArrivalTime)

setEstimatedDepartureTime

public IntermediateStop setEstimatedDepartureTime(ZonedDateTime estimatedDepartureTime)

setEstimatedDepartureTime

public IntermediateStop setEstimatedDepartureTime(String estimatedDepartureTime)

setAdditionalInfo

public IntermediateStop setAdditionalInfo(Map<String,Object> additionalInfo)

createMinimal

public static IntermediateStop createMinimal(Location<?> stop)

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 IntermediateStop

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntermediateStop

Method Detail

getStop

getPlannedArrivalTime

getPlannedArrivalTimeAsZonedDateTime

getPlannedDepartureTime

getPlannedDepartureTimeAsZonedDateTime

getEstimatedArrivalTime

getEstimatedArrivalTimeAsZonedDateTime

getEstimatedDepartureTime

getEstimatedDepartureTimeAsZonedDateTime

getAdditionalInfo

setStop

setPlannedArrivalTime

setPlannedArrivalTime

setPlannedDepartureTime

setPlannedDepartureTime

setEstimatedArrivalTime

setEstimatedArrivalTime

setEstimatedDepartureTime

setEstimatedDepartureTime

setAdditionalInfo

createMinimal

validate

hashCode

equals

toString