com.nbmap.api.directions.v5.models

Class BannerComponents

java.lang.Object

com.nbmap.api.directions.v5.models.DirectionsJsonObject

com.nbmap.api.directions.v5.models.BannerComponents

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BannerComponents>

public abstract class BannerComponents
extends DirectionsJsonObject
implements java.lang.Comparable<BannerComponents>

A part of the BannerText which includes a snippet of the full banner text instruction. In cases where data is available, an image url will be provided to visually include a road shield. To receive this information, your request must have NbmapDirections.Builder#bannerInstructions() set to true.

Since:

3.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BannerComponents.BannerComponentsSubType Banner component types.
static interface	BannerComponents.BannerComponentsType Banner component types.
static class	BannerComponents.Builder This builder can be used to set the values describing the BannerComponents.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELIMITER This is text that can be dropped, and should be dropped if you are rendering icons.
static java.lang.String	EXIT Provides the the word for exit in the local language.
static java.lang.String	EXIT_NUMBER Indicates the exit number for the maneuver.
static java.lang.String	GUIDANCE_VIEW This view gives guidance through junctions and is used to complete maneuvers.
static java.lang.String	ICON This is text that can be replaced by an imageBaseURL icon.
static java.lang.String	JCT This view gives guidance through junctions and is used to complete maneuvers.
static java.lang.String	LANE Indicates which lanes can be used to complete the maneuver.
static java.lang.String	SIGNBOARD This view gives guidance through signboards and is used to complete maneuvers.
static java.lang.String	TEXT Default.

Constructor Summary

Constructors

Constructor and Description
BannerComponents()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	abbreviation() The abbreviated form of text.
abstract java.lang.Integer	abbreviationPriority() An integer indicating the order in which the abbreviation abbr should be used in place of text.
abstract java.lang.Boolean	active() A boolean telling you if that lane can be used to complete the upcoming maneuver.
static BannerComponents.Builder	builder() Create a new instance of this class by using the BannerComponents.Builder class.
int	compareTo(BannerComponents bannerComponents) Allows ability to sort/compare by abbreviation priority.
abstract java.util.List<java.lang.String>	directions() A List of directions indicating which way you can go from a lane (left, right, or straight).
static BannerComponents	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	imageBaseUrl() In some cases when the LegStep is a highway or major roadway, there might be a shield icon that's included to better identify to your user to roadway.
abstract java.lang.String	imageUrl() In some cases when the StepManeuver will be difficult to navigate, an image can describe how to proceed.
abstract java.lang.String	subType() String giving you more context about BannerComponents.BannerComponentsType which may help in visual markup/display choices.
abstract java.lang.String	text() A snippet of the full BannerText.text() which can be used for visually altering parts of the full string.
abstract BannerComponents.Builder	toBuilder() Convert the current BannerComponents to its builder holding the currently assigned values.
abstract java.lang.String	type() String giving you more context about the component which may help in visual markup/display choices.
static com.google.gson.TypeAdapter<BannerComponents>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class com.nbmap.api.directions.v5.models.DirectionsJsonObject

toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEXT

public static final java.lang.String TEXT

Default. Indicates the text is part of the instructions and no other type.

Since:

3.0.0

See Also:

Constant Field Values

ICON

public static final java.lang.String ICON

This is text that can be replaced by an imageBaseURL icon.

Since:

3.0.0

See Also:

Constant Field Values

DELIMITER

public static final java.lang.String DELIMITER

This is text that can be dropped, and should be dropped if you are rendering icons.

Since:

3.0.0

See Also:

Constant Field Values

EXIT_NUMBER

public static final java.lang.String EXIT_NUMBER

Indicates the exit number for the maneuver.

Since:

3.0.0

See Also:

Constant Field Values

EXIT

public static final java.lang.String EXIT

Provides the the word for exit in the local language.

Since:

3.0.0

See Also:

Constant Field Values

LANE

public static final java.lang.String LANE

Indicates which lanes can be used to complete the maneuver.

Since:

3.0.0

See Also:

Constant Field Values

GUIDANCE_VIEW

public static final java.lang.String GUIDANCE_VIEW

This view gives guidance through junctions and is used to complete maneuvers.

See Also:

Constant Field Values

SIGNBOARD

public static final java.lang.String SIGNBOARD

This view gives guidance through signboards and is used to complete maneuvers.

See Also:

Constant Field Values

JCT

public static final java.lang.String JCT

This view gives guidance through junctions and is used to complete maneuvers.

See Also:

Constant Field Values

Constructor Detail

BannerComponents

public BannerComponents()

Method Detail

builder

public static BannerComponents.Builder builder()

Create a new instance of this class by using the BannerComponents.Builder class.

Returns:

this classes BannerComponents.Builder for creating a new instance

Since:

3.0.0

text

@NonNull
public abstract java.lang.String text()

A snippet of the full BannerText.text() which can be used for visually altering parts of the full string.

Returns:

a single snippet of the full text instruction

Since:

3.0.0

type

@NonNull
public abstract java.lang.String type()

String giving you more context about the component which may help in visual markup/display choices. If the type of the components is unknown it should be treated as text.

Possible values:

• text (default): indicates the text is part of the instructions and no other type
• icon: this is text that can be replaced by an icon, see imageBaseURL
• delimiter: this is text that can be dropped and should be dropped if you are rendering icons
• exit-number: the exit number for the maneuver
• exit: the word for exit in the local language

Returns:

String type from above list

Since:

3.0.0

subType

@Nullable
public abstract java.lang.String subType()

String giving you more context about BannerComponents.BannerComponentsType which may help in visual markup/display choices.

Possible values:

• jct: indicates a junction guidance view.
• signboard: indicates a signboard guidance view.

Returns:

String type from above list

abbreviation

@Nullable
 @SerializedName(value="abbr")
public abstract java.lang.String abbreviation()

The abbreviated form of text.

If this is present, there will also be an abbr_priority value.

Returns:

abbreviated form of text().

Since:

3.0.0

abbreviationPriority

@Nullable
 @SerializedName(value="abbr_priority")
public abstract java.lang.Integer abbreviationPriority()

An integer indicating the order in which the abbreviation abbr should be used in place of text. The highest priority is 0 and a higher integer value indicates a lower priority. There are no gaps in integer values.

Multiple components can have the same abbreviationPriority and when this happens all components with the same abbr_priority should be abbreviated at the same time. Finding no larger values of abbreviationPriority indicates that the string is fully abbreviated.

Returns:

Integer indicating the order of the abbreviation

Since:

3.0.0

imageBaseUrl

@Nullable
 @SerializedName(value="imageBaseURL")
public abstract java.lang.String imageBaseUrl()

In some cases when the LegStep is a highway or major roadway, there might be a shield icon that's included to better identify to your user to roadway. Note that this doesn't return the image itself but rather the url which can be used to download the file.

Returns:

the url which can be used to download the shield icon if one is available

Since:

3.0.0

imageUrl

@Nullable
 @SerializedName(value="imageURL")
public abstract java.lang.String imageUrl()

In some cases when the StepManeuver will be difficult to navigate, an image can describe how to proceed. The domain name for this image is a Junction View. Unlike the imageBaseUrl, this image url does not include image density encodings.

Returns:

the url which can be used to download the image.

Since:

5.0.0

directions

@Nullable
public abstract java.util.List<java.lang.String> directions()

A List of directions indicating which way you can go from a lane (left, right, or straight). If the value is ['left', 'straight'], the driver can go straight or left from that lane. Present if this is a lane component.

Returns:

List of allowed directions from that lane.

Since:

3.2.0

active

@Nullable
public abstract java.lang.Boolean active()

A boolean telling you if that lane can be used to complete the upcoming maneuver. If multiple lanes are active, then they can all be used to complete the upcoming maneuver. Present if this is a lane component.

Returns:

List of allowed directions from that lane.

Since:

3.2.0

toBuilder

public abstract BannerComponents.Builder toBuilder()

Convert the current BannerComponents to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified BannerComponents.

Returns:

a BannerComponents.Builder with the same values set to match the ones defined in this BannerComponents

Since:

3.1.0

typeAdapter

public static com.google.gson.TypeAdapter<BannerComponents> typeAdapter(com.google.gson.Gson gson)

Gson type adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the type adapter for this class

Since:

3.0.0

fromJson

public static BannerComponents fromJson(java.lang.String json)

Create a new instance of this class by passing in a formatted valid JSON String.

Parameters:

json - a formatted valid JSON string defining a BannerComponents

Returns:

a new instance of this class defined by the values passed inside this static factory method

Since:

3.4.0

compareTo

public int compareTo(BannerComponents bannerComponents)

Allows ability to sort/compare by abbreviation priority. This is null-safe for values of abbreviationPriority, and treats BannerComponents with a null abreviationPriority as having an abbreviationPriority of infinity. This method returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable<BannerComponents>

Parameters:

bannerComponents - to compare to

Returns:

the compareTo int value

Since:

3.0.0