HERE Android SDK Developer's Guide

TransitDeparture

The class TransitDeparture is a member of com.here.android.mpa.search .

Class Summary

public class TransitDeparture

extends java.lang.Object

Represents information about a single departure.

[For complete information, see the section Class Details]

Field Summary

Table 1. Fields in TransitDeparture
Fields

public static final String DEPARTURE_PLATFORM_KEY_NAME

Key name to retrieve the departure platform information.

public static final String DEPARTURE_TIME_KEY_NAME

Key name to retrieve departure time ( RFC 3339 date-time format with timezone offset).

public static final String EXCEPTION_EVENT_ADDITIONAL

Additional departure information provided.

public static final String EXCEPTION_EVENT_CANCELLED

Departure has been cancelled.

public static final String EXCEPTION_EVENT_REDIRECTED

Departure has been redirected.

public static final String EXCEPTION_EVENT_REPLACED

Departure has been replaced.

Method Summary

Table 2. Methods in TransitDeparture
Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public String getDirection ()

Gets direction of the departure on the line.

public String getException ()

An indicator for some exceptional event happened to this departure.

public java.util.List <ExtendedAttribute> getExtendedAttributes ()

Gets list of ExtendedAttribute features of departure.

public String getLine ()

Reference to the line in transit lines collection information.

public String getOperator ()

Gets a reference to the operator in the operators collection information.

public Map getRealTimeInformation ()

Gets the real (actual) departure time information.

public Map getScheduledTimeInformation ()

Gets the originally scheduled departure time information.

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Represents information about a single departure. All times use RFC 3339 date-time format with timezone offset.

Field Details

public static final String DEPARTURE_PLATFORM_KEY_NAME

Key name to retrieve the departure platform information.

public static final String DEPARTURE_TIME_KEY_NAME

Key name to retrieve departure time ( RFC 3339 date-time format with timezone offset).

public static final String EXCEPTION_EVENT_ADDITIONAL

Additional departure information provided.

public static final String EXCEPTION_EVENT_CANCELLED

Departure has been cancelled.

public static final String EXCEPTION_EVENT_REDIRECTED

Departure has been redirected.

public static final String EXCEPTION_EVENT_REPLACED

Departure has been replaced.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

  • obj

public String getDirection ()

Gets direction of the departure on the line.

Returns:

The departure direction on the line.

public String getException ()

An indicator for some exceptional event happened to this departure. Possible values are: EXCEPTION_EVENT_REDIRECTED , EXCEPTION_EVENT_REPLACED , EXCEPTION_EVENT_CANCELLED and EXCEPTION_EVENT_ADDITIONAL .

Returns:

Exception event (if any have occurred).

public java.util.List <ExtendedAttribute> getExtendedAttributes ()

Gets list of ExtendedAttribute features of departure. Supported keys are bikeAllowed and barrierFree .

Returns:

List of departure ExtendedAttribute.

public String getLine ()

Reference to the line in transit lines collection information.

Returns:

The line name.

public String getOperator ()

Gets a reference to the operator in the operators collection information.

Returns:

The operator name.

public Map getRealTimeInformation ()

Gets the real (actual) departure time information. The departure key represents the departure time.

Known key identifier values are:

  • DEPARTURE_TIME_KEY_NAME - real-time departure time (RFC 3339 date-time)
  • DEPARTURE_PLATFORM_KEY_NAME - real-time departure platform (optional)

Returns:

The map collection of real (actual) departure time information.

public Map getScheduledTimeInformation ()

Gets the originally scheduled departure time information.

Known key identifier values are:

  • DEPARTURE_TIME_KEY_NAME - scheduled departure time ( RFC 3339 date-time)
  • DEPARTURE_PLATFORM_KEY_NAME - scheduled departure platform (optional)

Returns:

The map collection of originally scheduled departure time information.

public int hashCode ()

For documentation, see java.lang.Object