Enum MatchSideOfStreet

  • java.lang.Object
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MatchSideOfStreet>

    public enum MatchSideOfStreet
    extends java.lang.Enum<MatchSideOfStreet>

    Specifies how the location set by Waypoint.sideOfStreetHint should be handled. This setting might affect the geometry of the resulting route.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS
      Always prefer the given side of street regardless if the street has dividers.
      ONLY_IF_DIVIDED
      Only prefer using side of street set by street hint in case the street has dividers.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static MatchSideOfStreet valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MatchSideOfStreet[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ALWAYS

        public static final MatchSideOfStreet ALWAYS

        Always prefer the given side of street regardless if the street has dividers. Use this value if you know that the user is willing to take a longer route in order to ensure arriving at the correct side of the street.

      • ONLY_IF_DIVIDED

        public static final MatchSideOfStreet ONLY_IF_DIVIDED

        Only prefer using side of street set by street hint in case the street has dividers. This is the default setting and it is recommended for most use cases.

    • Method Detail

      • values

        public static MatchSideOfStreet[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (MatchSideOfStreet c : MatchSideOfStreet.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static MatchSideOfStreet valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null