Class ViolatedRestriction

  • java.lang.Object
    • com.here.sdk.routing.ViolatedRestriction

  • public final class ViolatedRestriction
    extends java.lang.Object

    ViolatedRestriction contains all the violated restriction details for the planned trip.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ViolatedRestriction.Details
      Optional restriction details, contains additional information depending on the specific violation, zero or more member might be set.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String cause
      Cause of the notice.
      ViolatedRestriction.Details details
      The detailed information of restriction depending on the specific violation.
      boolean timeDependent
      Indicates that restriction depends on time.
    • Constructor Summary

      Constructors 
      Constructor Description
      ViolatedRestriction​(java.lang.String cause, boolean timeDependent)
      Creates a new instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int hashCode()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • cause

        @NonNull
        public java.lang.String cause

        Cause of the notice. Human readable description of the notice, for example "Route violates vehicle restriction". It will be EN-US text only.

      • timeDependent

        public boolean timeDependent

        Indicates that restriction depends on time.

      • details

        @Nullable
        public ViolatedRestriction.Details details

        The detailed information of restriction depending on the specific violation. For time dependent restriction or transport mode restriction, this property will be null. For vehicle restriction, the corresponding member will be set, for example, if the vehicle violates the maximum allowed gross weight for a specific route, the max_gross_weight_in_kilograms will be set with the maximum allowed gross weight for this route.

    • Constructor Detail

      • ViolatedRestriction

        public ViolatedRestriction​(@NonNull
                                   java.lang.String cause,
                                   boolean timeDependent)

        Creates a new instance.

        Parameters:
        cause -

        Cause of the notice. Human readable description of the notice, for example "Route violates vehicle restriction". It will be EN-US text only.

        timeDependent -

        Indicates that restriction depends on time.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object