Package com.here.sdk.warner

Class WarningsRegistry

java.lang.Object
com.here.NativeBase
com.here.sdk.warner.WarningsRegistry
public final class WarningsRegistry extends NativeBase

A class that store warning metadata for different warning types. Aggregates individual collection for each warning category (safety cameras, truck restrictions, etc.). Provided by WarnerEngine so callers can lookup detailed information about specific warnings.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

  • Method Details

    • getSafetyCameraWarning

      @Nullable public SafetyCameraWarning getSafetyCameraWarning(@NonNull Warning warning)

      Returns a safety-camera warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single safety-camera warning within this registry and is used to retrieve its full metadata.

      Returns:

      The SafetyCameraWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getTruckRestrictionWarning

      @Nullable public TruckRestrictionWarning getTruckRestrictionWarning(@NonNull Warning warning)

      Returns a truck restrictions warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single truck restrictions warning within this registry and is used to retrieve its full metadata.

      Returns:

      The TruckRestrictionWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getRoadSignWarning

      @Nullable public RoadSignWarning getRoadSignWarning(@NonNull Warning warning)

      Returns a road-sign warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single road sign warning within this registry and is used to retrieve its full metadata.

      Returns:

      The sdk.navigation.RoadSignWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getRealisticViewWarning

      @Nullable public RealisticViewWarning getRealisticViewWarning(@NonNull Warning warning)

      Returns a realistic-view warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single realistic-view warning within this registry and is used to retrieve its full metadata.

      Returns:

      The RealisticViewWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getEnvironmentalZoneWarning

      @Nullable public EnvironmentalZoneWarning getEnvironmentalZoneWarning(@NonNull Warning warning)

      Returns environmental zone warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single environmental zone warning within this registry and is used to retrieve its full metadata.

      Returns:

      The EnvironmentalZoneWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getSchoolZoneWarning

      @Nullable public SchoolZoneWarning getSchoolZoneWarning(@NonNull Warning warning)

      Returns a school zone warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single school zone warning within this registry and is used to retrieve its full metadata.

      Returns:

      The SchoolZoneWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getTollStopWarning

      @Nullable public TollStop getTollStopWarning(@NonNull Warning warning)

      Returns a toll stop warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single toll stop warning within this registry and is used to retrieve its full metadata.

      Returns:

      The TollStop object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getDangerZoneWarning

      @Nullable public DangerZoneWarning getDangerZoneWarning(@NonNull Warning warning)

      Returns a danger zone warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single danger zone warning within this registry and is used to retrieve its full metadata.

      Returns:

      The DangerZoneWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getBorderCrossingWarning

      @Nullable public BorderCrossingWarning getBorderCrossingWarning(@NonNull Warning warning)

      Returns a border crossing warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single border crossing warning within this registry and is used to retrieve its full metadata.

      Returns:

      The BorderCrossingWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getRailwayCrossingWarning

      @Nullable public RailwayCrossingWarning getRailwayCrossingWarning(@NonNull Warning warning)

      Returns a railway crossing warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single railway crossing warning within this registry and is used to retrieve its full metadata.

      Returns:

      The RailwayCrossingWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getLowSpeedZoneWarning

      @Nullable public LowSpeedZoneWarning getLowSpeedZoneWarning(@NonNull Warning warning)

      Returns a low speed zone warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single low speed zone warning within this registry and is used to retrieve its full metadata.

      Returns:

      The LowSpeedZoneWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getTrafficMergeWarning

      @Nullable public TrafficMergeWarning getTrafficMergeWarning(@NonNull Warning warning)

      Returns a traffic merge warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single traffic merge warning within this registry and is used to retrieve its full metadata.

      Returns:

      The sdk.navigation.TrafficMergeWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

    • getLaneDecreaseWarning

      @Nullable public LaneDecreaseWarning getLaneDecreaseWarning(@NonNull Warning warning)

      Returns a lane decrease warning corresponding to the given identifier.

      Parameters:
      warning -

      The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single lane decrease warning within this registry and is used to retrieve its full metadata.

      Returns:

      The LaneDecreaseWarning object associated with the provided warning, or null if no warning exists for the given warning. This object contains the full details and attributes of the corresponding warning.

      Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

    • getCustomWarning

      @Nullable public CustomWarning getCustomWarning(@NonNull Warning warning)

      Returns additional data associated with the given custom warning.

      The provided warning identifies a specific custom warning instance by its base warning information and custom warning type. This information is used to resolve the corresponding entry in the warning registry and retrieve any additional, type-specific data associated with the warning.

      Parameters:
      warning -

      The Warning instance identifying the custom warning for which additional data should be retrieved.

      Returns:

      The CustomWarning associated with the given warning, or null if no additional data exists for this warning. The returned object contains the payload with type-specific details and attributes of the corresponding warning.

      Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.