Class RouteFerryLegDetails

    • Method Detail

      • hasAfterTravelSteps

        public final boolean hasAfterTravelSteps()
        For responses, this returns true if the service returned a value for the AfterTravelSteps 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.
      • afterTravelSteps

        public final List<RouteFerryAfterTravelStep> afterTravelSteps()

        Steps of a leg that must be performed after the travel portion of the leg.

        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 hasAfterTravelSteps() method.

        Returns:
        Steps of a leg that must be performed after the travel portion of the leg.
      • arrival

        public final RouteFerryArrival arrival()

        Details corresponding to the arrival for the leg.

        Returns:
        Details corresponding to the arrival for the leg.
      • hasBeforeTravelSteps

        public final boolean hasBeforeTravelSteps()
        For responses, this returns true if the service returned a value for the BeforeTravelSteps 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.
      • beforeTravelSteps

        public final List<RouteFerryBeforeTravelStep> beforeTravelSteps()

        Steps of a leg that must be performed before the travel portion of the leg.

        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 hasBeforeTravelSteps() method.

        Returns:
        Steps of a leg that must be performed before the travel portion of the leg.
      • departure

        public final RouteFerryDeparture departure()

        Details corresponding to the departure for the leg.

        Returns:
        Details corresponding to the departure for the leg.
      • hasNotices

        public final boolean hasNotices()
        For responses, this returns true if the service returned a value for the Notices 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.
      • notices

        public final List<RouteFerryNotice> notices()

        Notices are additional information returned that indicate issues that occurred during route calculation.

        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 hasNotices() method.

        Returns:
        Notices are additional information returned that indicate issues that occurred during route calculation.
      • hasPassThroughWaypoints

        public final boolean hasPassThroughWaypoints()
        For responses, this returns true if the service returned a value for the PassThroughWaypoints 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.
      • passThroughWaypoints

        public final List<RoutePassThroughWaypoint> passThroughWaypoints()

        Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.

        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 hasPassThroughWaypoints() method.

        Returns:
        Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
      • routeName

        public final String routeName()

        Route name of the ferry line.

        Returns:
        Route name of the ferry line.
      • hasSpans

        public final boolean hasSpans()
        For responses, this returns true if the service returned a value for the Spans 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.
      • spans

        public final List<RouteFerrySpan> spans()

        Spans that were computed for the requested SpanAdditionalFeatures.

        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 hasSpans() method.

        Returns:
        Spans that were computed for the requested SpanAdditionalFeatures.
      • summary

        public final RouteFerrySummary summary()

        Summarized details of the leg.

        Returns:
        Summarized details of the leg.
      • hasTravelSteps

        public final boolean hasTravelSteps()
        For responses, this returns true if the service returned a value for the TravelSteps 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.
      • travelSteps

        public final List<RouteFerryTravelStep> travelSteps()

        Steps of a leg that must be performed before the travel portion of the leg.

        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 hasTravelSteps() method.

        Returns:
        Steps of a leg that must be performed before the travel portion of the leg.
      • 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)