Package com.highmobility.autoapi.property

Class PropertyComponentFailure

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Byte>

com.highmobility.value.Bytes

com.highmobility.autoapi.property.PropertyComponent

com.highmobility.autoapi.property.PropertyComponentFailure

All Implemented Interfaces:

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

public class PropertyComponentFailure
extends PropertyComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PropertyComponentFailure.Reason	Deprecated. use Failure.getReason() instead

Field Summary

Fields inherited from class com.highmobility.value.Bytes

bytes

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
PropertyComponentFailure(PropertyComponentFailure.Reason failureReason, String description)	Deprecated. use PropertyComponentFailure(Failure) instead
PropertyComponentFailure(Failure failure)	Create a FailureComponent with Failure object
PropertyComponentFailure(com.highmobility.value.Bytes bytes)

Method Summary

Modifier and Type	Method	Description
Failure	getFailure()
String	getFailureDescription()
PropertyComponentFailure.Reason	getFailureReason()	Deprecated. use getFailure() instead

Methods inherited from class com.highmobility.autoapi.property.PropertyComponent

getIdentifier, getValueBytes

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

Constructor Details

PropertyComponentFailure

public PropertyComponentFailure(com.highmobility.value.Bytes bytes)
                         throws CommandParseException

Throws:

CommandParseException

PropertyComponentFailure

public PropertyComponentFailure(PropertyComponentFailure.Reason failureReason,
 @Nullable
 String description)
                         throws CommandParseException

Deprecated.

use PropertyComponentFailure(Failure) instead

Parameters:

failureReason - The failure reason.

description - The failure description.

Throws:

CommandParseException - if cannot convert from Reason to Failure.Reason

PropertyComponentFailure

public PropertyComponentFailure(Failure failure)

Create a FailureComponent with Failure object

Parameters:

failure - The failure object

Method Details

getFailure

public Failure getFailure()

Returns:

The failure object

getFailureReason

@Deprecated
public PropertyComponentFailure.Reason getFailureReason()
                                                 throws CommandParseException

Deprecated.

use getFailure() instead

Returns:

The failure reason.

Throws:

CommandParseException - if cannot convert from Reason to Failure.Reason

getFailureDescription

@Nullable
public String getFailureDescription()

Returns:

The failure description.