Package com.here.sdk.warner

Class Warning

java.lang.Object

com.here.sdk.warner.Warning

public final class Warning
extends Object

A class which represents a 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.

Field Summary

Fields

Modifier and Type	Field	Description
Integer	customWarningType	Identifier of the custom warning type.
DistanceType	distanceType	The type of distance measurement used for this warning.
int	id	Identifier of the warning.
WarningType	warningType	The specific type of the warning.

Constructor Summary

Constructors

Constructor	Description
Warning(int id, DistanceType distanceType, WarningType warningType)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

id

public int id

Identifier of the warning. The ID is unique only within its specific warningType and can be used to retrieve additional information from a corresponding registry.

distanceType

@NonNull
public DistanceType distanceType

The type of distance measurement used for this warning.

warningType

@NonNull
public WarningType warningType

The specific type of the warning.

customWarningType

@Nullable
public Integer customWarningType

Identifier of the custom warning type.

Defines the category of the custom warning and determines which warning registry should be used to retrieve additional warning details. This field is set only when warningType == WarningType.CUSTOM and is null for all other warning types.

Constructor Details

Warning

public Warning(int id,
 @NonNull
 DistanceType distanceType,
 @NonNull
 WarningType warningType)

Creates a new instance.

Parameters:

id -

Identifier of the warning. The ID is unique only within its specific warningType and can be used to retrieve additional information from a corresponding registry.

distanceType -

The type of distance measurement used for this warning.

warningType -

The specific type of the warning.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object