Package com.highmobility.autoapi

Class FailureMessage.State

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Byte>

com.highmobility.value.Bytes

com.highmobility.autoapi.Command

com.highmobility.autoapi.SetCommand

com.highmobility.autoapi.FailureMessage.State

All Implemented Interfaces:

Iterable<Byte>, Collection<Byte>, List<Byte>

Enclosing class:

FailureMessage

public static class FailureMessage.State
extends SetCommand

The failure message state

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FailureMessage.State.Builder

Nested classes/interfaces inherited from class com.highmobility.autoapi.SetCommand

SetCommand.BaseBuilder

Nested classes/interfaces inherited from class com.highmobility.autoapi.Command

Command.HandleNotParsedProperty, Command.PropertyIteration, Command.PropertyIterator

Field Summary

Fields inherited from class com.highmobility.autoapi.Command

BRAND_IDENTIFIER, NONCE_IDENTIFIER, propertyIterator, SIGNATURE_IDENTIFIER, TIMESTAMP_IDENTIFIER, universalPropertyIds, VIN_IDENTIFIER

Fields inherited from class com.highmobility.value.Bytes

bytes

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method	Description
boolean	getCommandFailed(Integer identifier, Integer type)	Understand whether a set/get command failed
PropertyInteger	getFailedMessageID()
PropertyInteger	getFailedMessageType()
Property<com.highmobility.value.Bytes>	getFailedPropertyIDs()
Property<String>	getFailureDescription()
Property<FailureMessage.FailureReason>	getFailureReason()
boolean	getPropertyFailed(Integer capabilityIdentifier, byte propertyIdentifier)	Understand whether a specific message failed

Methods inherited from class com.highmobility.autoapi.SetCommand

addProperty, createBytes, mandatoryPropertyErrorMessage, optionalPropertyErrorMessage

Methods inherited from class com.highmobility.autoapi.Command

findUniversalProperties, findUniversalProperties, getAutoApiVersion, getBrand, getCommandType, getIdentifier, getNonce, getProperties, getProperty, getSignature, getSignedBytes, getTimestamp, getVin

Methods inherited from class com.highmobility.value.Bytes

concat, concat, equals, get, getBase64, getBase64UrlSafe, getByteArray, getHex, getLength, getRange, set, set, set, size, toString

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Method Details

getFailedMessageID

public PropertyInteger getFailedMessageID()

Returns:

Capability identifier of the failed message

getFailedMessageType

public PropertyInteger getFailedMessageType()

Returns:

Message type of the failed message

getFailureReason

public Property<FailureMessage.FailureReason> getFailureReason()

Returns:

The failure reason

getFailureDescription

public Property<String> getFailureDescription()

Returns:

Failure description

getFailedPropertyIDs

public Property<com.highmobility.value.Bytes> getFailedPropertyIDs()

Returns:

Array of failed property identifiers

getPropertyFailed

public boolean getPropertyFailed(Integer capabilityIdentifier,
 byte propertyIdentifier)

Understand whether a specific message failed

Parameters:

capabilityIdentifier - The command capability identifier

propertyIdentifier - The property identifier

Returns:

Whether the command failed.

getCommandFailed

public boolean getCommandFailed(Integer identifier,
 Integer type)

Understand whether a set/get command failed

Parameters:

identifier - The command identifier

type - The command type

Returns:

Whether the command failed.