Package com.highmobility.autoapi.property

Class Property<V>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Byte>

com.highmobility.value.Bytes

com.highmobility.autoapi.property.Property<V>

Type Parameters:

V - The value type. Eg Integer, CheckControlMessage, Duration

All Implemented Interfaces:

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

Direct Known Subclasses:

PropertyInteger

public class Property<V>
extends com.highmobility.value.Bytes

Property is a representation of some AutoAPI data. It consists of 4 optional components: data, unit timestamp, failure

Field Summary

Fields

Modifier and Type	Field	Description
protected com.highmobility.autoapi.property.PropertyComponentAvailability	availability
protected List<PropertyComponent>	components
protected PropertyComponentFailure	failure
protected PropertyComponentTimestamp	timestamp
protected static final byte[]	unknownBytes
protected PropertyComponentValue<V>	value

Fields inherited from class com.highmobility.value.Bytes

bytes

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
Property(byte[] bytes)
Property(byte identifier, V value)
Property(byte identifier, V value, Calendar timestamp, PropertyComponentFailure failure, com.highmobility.autoapi.property.PropertyComponentAvailability availability)
Property(int identifier, V value)
Property(Class<V> valueClass, byte identifier)
Property(Class<V> valueClass, int identifier)
Property(Class<V> valueClass, Property property)
Property(V value)

Method Summary

Modifier and Type	Method	Description
Property	addValueComponent(com.highmobility.value.Bytes valueComponentValue)
static byte	boolToByte(boolean value)
static byte[]	calendarToBytes(Calendar calendar)
protected void	createBytesFromComponents(byte propertyIdentifier)
static byte[]	doubleToBytes(double value)
protected void	findComponents()
static byte[]	floatToBytes(float value)
static int	floatToIntPercentage(float value)
static byte	floatToIntPercentageByte(float value)
Availability	getAvailability()
static Boolean	getBool(byte value)
static byte	getByte(boolean value)
static Calendar	getCalendar(byte[] bytes)
static Calendar	getCalendar(byte[] bytes, int at)
static Calendar	getCalendar(byte[] bytes, int at, int length)
static Calendar	getCalendar(Property property)
static Calendar	getCalendar(com.highmobility.value.Bytes bytes)
PropertyComponent	getComponent(byte identifier)
List<PropertyComponent>	getComponents()
static Date	getDate(byte[] bytes)
static double	getDouble(byte[] bytes)
static double	getDouble(byte[] bytes, int at)
static double	getDouble(com.highmobility.value.Bytes bytes)
static double	getDouble(com.highmobility.value.Bytes bytes, int at)
PropertyComponentFailure	getFailureComponent()
static float	getFloat(byte[] bytes)
static float	getFloat(byte[] bytes, int at)
static float	getFloat(com.highmobility.value.Bytes bytes)
static float	getFloat(com.highmobility.value.Bytes bytes, int at)
static int[]	getIntegerArray(com.highmobility.value.Bytes valueBytes)
static long	getLong(byte[] b)
static long	getLong(byte[] b, int at)
static long	getLong(byte[] b, int at, int length)
static float	getPercentage(byte value)
byte	getPropertyIdentifier()
int	getPropertyLength()
static int	getSignedInt(byte value)
static int	getSignedInt(byte[] bytes)
static int	getSignedInt(byte[] bytes, int at, int length)
static int	getSignedInt(com.highmobility.value.Bytes bytes)
static String	getString(byte[] bytes)
static String	getString(byte[] bytes, int at, int length)
static String	getString(com.highmobility.value.Bytes bytes)
static String	getString(com.highmobility.value.Bytes bytes, int at, int length)
Calendar	getTimestamp()
static int	getUnsignedInt(byte value)
static int	getUnsignedInt(byte[] bytes)
static int	getUnsignedInt(byte[] bytes, int at, int length)
static int	getUnsignedInt(com.highmobility.value.Bytes bytes)
static int	getUnsignedInt(com.highmobility.value.Bytes bytes, int at, int length)
static int	getUtf8Length(CharSequence sequence)
V	getValue()
PropertyComponentValue	getValueComponent()
static com.highmobility.value.Bytes	integerArrayToBytes(int[] value)
static byte[]	intToBytes(int value, int length)	This works for both negative and positive ints.
boolean	isUniversalProperty()
static byte[]	longToBytes(long l)
void	printFailedToParse(Exception e, com.highmobility.value.Bytes component)
Property<V>	setIdentifier(byte identifier)	Set a new identifier for the property
Property<V>	setIdentifier(int identifier)
static byte[]	stringToBytes(String string)
Property	update(Property p)
Property	update(V value)

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

Field Details

unknownBytes

protected static final byte[] unknownBytes

value

@Nullable
protected PropertyComponentValue<V> value

timestamp

@Nullable
protected PropertyComponentTimestamp timestamp

failure

@Nullable
protected PropertyComponentFailure failure

availability

@Nullable
protected com.highmobility.autoapi.property.PropertyComponentAvailability availability

components

protected List<PropertyComponent> components

Constructor Details

Property

public Property(byte[] bytes)

Property

public Property(@Nullable
 V value)

Property

public Property(byte identifier,
 @Nullable
 V value,
 @Nullable
 Calendar timestamp,
 @Nullable
 PropertyComponentFailure failure,
 @Nullable
 com.highmobility.autoapi.property.PropertyComponentAvailability availability)

Property

public Property(int identifier,
 V value)

Property

public Property(byte identifier,
 V value)

Property

public Property(Class<V> valueClass,
 int identifier)

Property

public Property(Class<V> valueClass,
 byte identifier)

Property

public Property(Class<V> valueClass,
 Property property)
         throws CommandParseException

Throws:

CommandParseException

Method Details

getPropertyIdentifier

public byte getPropertyIdentifier()

getValue

@Nullable
public V getValue()

Returns:

The property value.

getComponents

public List<PropertyComponent> getComponents()

Returns:

All of the components.

getComponent

@Nullable
public PropertyComponent getComponent(byte identifier)

Parameters:

identifier - The component identifier.

Returns:

The component with the given identifier.

getValueComponent

@Nullable
public PropertyComponentValue getValueComponent()

Returns:

The value component.

getTimestamp

@Nullable
public Calendar getTimestamp()

Returns:

The timestamp of the property.

getAvailability

@Nullable
public Availability getAvailability()

Returns:

The availability of the property.

getFailureComponent

@Nullable
public PropertyComponentFailure getFailureComponent()

Returns:

The failure of the property.

getPropertyLength

public int getPropertyLength()

Returns:

The length of the property components(not including the header).

findComponents

protected void findComponents()

update

public Property update(Property p)
                throws CommandParseException

Throws:

CommandParseException

update

public Property update(V value)

addValueComponent

public Property addValueComponent(com.highmobility.value.Bytes valueComponentValue)

createBytesFromComponents

protected void createBytesFromComponents(byte propertyIdentifier)

setIdentifier

public Property<V> setIdentifier(byte identifier)

Set a new identifier for the property

Parameters:

identifier - The identifier.

Returns:

Self.

setIdentifier

public Property<V> setIdentifier(int identifier)

isUniversalProperty

public boolean isUniversalProperty()

printFailedToParse

public void printFailedToParse(Exception e,
 com.highmobility.value.Bytes component)

getLong

public static long getLong(byte[] b,
 int at)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

getLong

public static long getLong(byte[] b,
 int at,
 int length)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

getLong

public static long getLong(byte[] b)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

longToBytes

public static byte[] longToBytes(long l)

getFloat

public static float getFloat(com.highmobility.value.Bytes bytes)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

getFloat

public static float getFloat(byte[] bytes)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

getFloat

public static float getFloat(byte[] bytes,
 int at)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

getFloat

public static float getFloat(com.highmobility.value.Bytes bytes,
 int at)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

floatToBytes

public static byte[] floatToBytes(float value)

getDouble

public static double getDouble(com.highmobility.value.Bytes bytes)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

getDouble

public static double getDouble(byte[] bytes)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

getDouble

public static double getDouble(byte[] bytes,
 int at)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

getDouble

public static double getDouble(com.highmobility.value.Bytes bytes,
 int at)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

doubleToBytes

public static byte[] doubleToBytes(double value)

floatToIntPercentage

public static int floatToIntPercentage(float value)

floatToIntPercentageByte

public static byte floatToIntPercentageByte(float value)

getPercentage

public static float getPercentage(byte value)

getUnsignedInt

public static int getUnsignedInt(byte value)

getUnsignedInt

public static int getUnsignedInt(com.highmobility.value.Bytes bytes)
                          throws IllegalArgumentException

Throws:

IllegalArgumentException

getUnsignedInt

public static int getUnsignedInt(byte[] bytes)
                          throws IllegalArgumentException

Throws:

IllegalArgumentException

getUnsignedInt

public static int getUnsignedInt(com.highmobility.value.Bytes bytes,
 int at,
 int length)
                          throws IllegalArgumentException

Throws:

IllegalArgumentException

getUnsignedInt

public static int getUnsignedInt(byte[] bytes,
 int at,
 int length)
                          throws IllegalArgumentException

Throws:

IllegalArgumentException

getSignedInt

public static int getSignedInt(byte value)

getSignedInt

public static int getSignedInt(com.highmobility.value.Bytes bytes)

getSignedInt

public static int getSignedInt(byte[] bytes)

getSignedInt

public static int getSignedInt(byte[] bytes,
 int at,
 int length)

intToBytes

public static byte[] intToBytes(int value,
 int length)
                         throws IllegalArgumentException

This works for both negative and positive ints.

Parameters:

value - the valueBytes converted to byte[]

length - the returned byte[] length

Returns:

the allBytes representing the valueBytes

Throws:

IllegalArgumentException - when input is invalid

getBool

public static Boolean getBool(byte value)

boolToByte

public static byte boolToByte(boolean value)

getByte

public static byte getByte(boolean value)

getString

public static String getString(com.highmobility.value.Bytes bytes)

getString

public static String getString(byte[] bytes)

getString

public static String getString(com.highmobility.value.Bytes bytes,
 int at,
 int length)

getString

public static String getString(byte[] bytes,
 int at,
 int length)

stringToBytes

public static byte[] stringToBytes(String string)

getUtf8Length

public static int getUtf8Length(CharSequence sequence)

getDate

public static Date getDate(byte[] bytes)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

getCalendar

public static Calendar getCalendar(Property property)
                            throws IllegalArgumentException

Throws:

IllegalArgumentException

getCalendar

public static Calendar getCalendar(com.highmobility.value.Bytes bytes)
                            throws IllegalArgumentException

Throws:

IllegalArgumentException

getCalendar

public static Calendar getCalendar(byte[] bytes)
                            throws IllegalArgumentException

Throws:

IllegalArgumentException

getCalendar

public static Calendar getCalendar(byte[] bytes,
 int at)
                            throws IllegalArgumentException

Throws:

IllegalArgumentException

getCalendar

public static Calendar getCalendar(byte[] bytes,
 int at,
 int length)
                            throws IllegalArgumentException

Throws:

IllegalArgumentException

calendarToBytes

public static byte[] calendarToBytes(Calendar calendar)

getIntegerArray

public static int[] getIntegerArray(com.highmobility.value.Bytes valueBytes)

integerArrayToBytes

public static com.highmobility.value.Bytes integerArrayToBytes(int[] value)