Class RoutePedestrianTravelStep

    • Method Detail

      • continueStepDetails

        public final RouteContinueStepDetails continueStepDetails()

        Details related to the continue step.

        Returns:
        Details related to the continue step.
      • currentRoad

        public final RouteRoad currentRoad()

        Details of the current road. See RouteRoad for details of sub-attributes.

        Returns:
        Details of the current road. See RouteRoad for details of sub-attributes.
      • distance

        public final Long distance()

        Distance of the step.

        Returns:
        Distance of the step.
      • duration

        public final Long duration()

        Duration of the step.

        Unit: seconds

        Returns:
        Duration of the step.

        Unit: seconds

      • hasExitNumber

        public final boolean hasExitNumber()
        For responses, this returns true if the service returned a value for the ExitNumber property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • exitNumber

        public final List<LocalizedString> exitNumber()

        Exit number of the road exit, if applicable.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExitNumber() method.

        Returns:
        Exit number of the road exit, if applicable.
      • geometryOffset

        public final Integer geometryOffset()

        Offset in the leg geometry corresponding to the start of this step.

        Returns:
        Offset in the leg geometry corresponding to the start of this step.
      • instruction

        public final String instruction()

        Brief description of the step in the requested language.

        Only available when the TravelStepType is Default.

        Returns:
        Brief description of the step in the requested language.

        Only available when the TravelStepType is Default.

      • keepStepDetails

        public final RouteKeepStepDetails keepStepDetails()

        Details that are specific to a Keep step.

        Returns:
        Details that are specific to a Keep step.
      • nextRoad

        public final RouteRoad nextRoad()

        Details of the next road. See RouteRoad for details of sub-attributes.

        Returns:
        Details of the next road. See RouteRoad for details of sub-attributes.
      • roundaboutEnterStepDetails

        public final RouteRoundaboutEnterStepDetails roundaboutEnterStepDetails()

        Details that are specific to a Roundabout Enter step.

        Returns:
        Details that are specific to a Roundabout Enter step.
      • roundaboutExitStepDetails

        public final RouteRoundaboutExitStepDetails roundaboutExitStepDetails()

        Details that are specific to a Roundabout Exit step.

        Returns:
        Details that are specific to a Roundabout Exit step.
      • roundaboutPassStepDetails

        public final RouteRoundaboutPassStepDetails roundaboutPassStepDetails()

        Details that are specific to a Roundabout Pass step.

        Returns:
        Details that are specific to a Roundabout Pass step.
      • signpost

        public final RouteSignpost signpost()

        Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

        Returns:
        Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
      • turnStepDetails

        public final RouteTurnStepDetails turnStepDetails()

        Details that are specific to a turn step.

        Returns:
        Details that are specific to a turn step.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)