Package com.here.sdk.warner

Class CustomWarning

java.lang.Object

com.here.sdk.warner.CustomWarning

public final class CustomWarning
extends Object

class container for custom warning data.

This structure represents the type-specific payload associated with a custom warning.

Instances of this structure are typically produced by custom warning evaluation logic and may also be retrieved from the WarningRegistry.

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
int	customWarningType	Identifier of the custom warning type.
Double	endOffsetInMeters	End offset of the warning range along the segment.
int	id	Identifier of the warning.
Metadata	payload	Custom warning payload.
double	startOffsetInMeters	Start offset of the warning range along the segment.

Constructor Summary

Constructors

Constructor	Description
CustomWarning()	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 customWarningType and can be used to retrieve additional information from a corresponding registry.

customWarningType

public int 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.

startOffsetInMeters

public double startOffsetInMeters

Start offset of the warning range along the segment.

Specifies the distance, in meters, from the beginning of the corresponding ElectronicHorizonSegment at which the warning becomes applicable.

endOffsetInMeters

@Nullable
public Double endOffsetInMeters

End offset of the warning range along the segment.

Specifies the distance, in meters, from the beginning of the corresponding ElectronicHorizonSegment at which the warning is no longer applicable.

May be null. In this case, the value is automatically considered to be equal to startOffsetInMeters.

payload

@Nullable
public Metadata payload

Custom warning payload.

Contains warning-specific payload data. A value of null indicates that no additional data is associated with the warning.

Constructor Details

CustomWarning

public CustomWarning()

Creates a new instance.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object