OSGi 8.1.0 · org.osgi.service.dal.functions.data.LevelData

Modifier and Type	Field and Description
public static final String	FIELD_LEVEL Represents the level field name.
public static final String	FIELD_UNIT Represents the unit field name.
private final BigDecimal	level
private final String	unit

Access	Constructor and Description
public	LevelData(Map<String, ?> Contains the new `LevelData` instance field values. fields) Constructs new `LevelData` instance with the specified field values.
public	LevelData(long The data timestamp optional field. timestamp, Map<String, Object> The data metadata optional field. metadata, BigDecimal The level value mandatory field. level, String The data unit optional field. unit) Constructs new `LevelData` instance with the specified arguments.

Method Summary

Modifier and Type	Method and Description
public int	Returns: `-1`, `0` or `1` depending on the comparison rules. compareTo(Object `LevelData` to be compared. o) Overrides org.osgi.service.dal.FunctionData.compareTo. Implements java.lang.Comparable.compareTo. Compares this `LevelData` instance with the given argument.
public boolean	Returns: `true` if this object is equivalent to the specified one. equals(Object The object to compare this data. o) Overrides org.osgi.service.dal.FunctionData.equals. Two `LevelData` instances are equal if they contain equal metadata, timestamp, unit and level.
public BigDecimal	Returns: The `LevelData` value. getLevel() Returns `LevelData` value.
public String	Returns: The value unit or `null` if the unit is missing. getUnit() Returns `LevelData` unit as it's specified in `PropertyMetadata#UNITS` or `null` if the unit is missing.
public int	Returns: The hash code of this `LevelData` object. hashCode() Overrides org.osgi.service.dal.FunctionData.hashCode. Returns the hash code for this `LevelData` object.
public String	Returns: The string representation of this level data. toString() Overrides java.lang.Object.toString. Returns the string representation of this level data.

Inherited from org.osgi.service.dal.FunctionData:: getMetadata getTimestamp

Field Detail

FIELD_LEVEL	back to summary
public static final String FIELD_LEVEL Represents the level field name. The field value is available with `getLevel()`. The field type is `BigDecimal`. The constant can be used as a key to `LevelData(Map)`.

FIELD_UNIT	back to summary
public static final String FIELD_UNIT Represents the unit field name. The field value is available with `getUnit()`. The field type is `String`. The constant can be used as a key to `LevelData(Map)`.

level	back to summary
private final BigDecimal level

unit	back to summary
private final String unit

Constructor Detail

LevelData back to summary

LevelData	back to summary
public LevelData(Map<String, ?> fields) Constructs new `LevelData` instance with the specified field values. The map keys must match to the field names. The map values will be assigned to the appropriate class fields. For example, the maps can be: {"level"=BigDecimal(1)...}. That map will initialize the `FIELD_LEVEL` field with 1. `FIELD_LEVEL` - mandatory field. The value type must be `BigDecimal`. `FIELD_UNIT` - optional field. The value type must be `String`. Parameters fields:Map<String, ?> Contains the new `LevelData` instance field values. Exceptions ClassCastException: If the field value types are not expected. IllegalArgumentException: If the level is missing. NullPointerException: If the fields map is `null`.

public LevelData(Map<String, ?> fields)

Constructs new LevelData instance with the specified field values. The map keys must match to the field names. The map values will be assigned to the appropriate class fields. For example, the maps can be: {"level"=BigDecimal(1)...}. That map will initialize the FIELD_LEVEL field with 1.

FIELD_LEVEL - mandatory field. The value type must be BigDecimal.
FIELD_UNIT - optional field. The value type must be String.

Parameters

fields:Map<String, ?>: Contains the new LevelData instance field values.

Exceptions

ClassCastException:: If the field value types are not expected.
IllegalArgumentException:: If the level is missing.
NullPointerException:: If the fields map is null.

LevelData back to summary

LevelData	back to summary
public LevelData(long timestamp, Map<String, Object> metadata, BigDecimal level, String unit) Constructs new `LevelData` instance with the specified arguments. Parameters timestamp:long The data timestamp optional field. metadata:Map<String, Object> The data metadata optional field. level:BigDecimal The level value mandatory field. unit:String The data unit optional field. Exceptions NullPointerException: If `level` is `null`.

public LevelData(long timestamp, Map<String, Object> metadata, BigDecimal level, String unit)

Constructs new LevelData instance with the specified arguments.

Parameters

timestamp:long: The data timestamp optional field.
metadata:Map<String, Object>: The data metadata optional field.
level:BigDecimal: The level value mandatory field.
unit:String: The data unit optional field.

Exceptions

NullPointerException:: If level is null.

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(Object o) Overrides org.osgi.service.dal.FunctionData.compareTo. Implements java.lang.Comparable.compareTo. Compares this `LevelData` instance with the given argument. If the argument is not `LevelData`, it throws `ClassCastException`. Otherwise, this method returns: `-1` if this instance field is less than a field of the specified argument. `0` if all fields are equivalent. `1` if this instance field is greater than a field of the specified argument. The fields are compared in this order: timestamp, metadata, level, unit. Parameters o:Object `LevelData` to be compared. Returns:int `-1`, `0` or `1` depending on the comparison rules. Annotations @Override Exceptions ClassCastException: If the method argument is not of type `LevelData`. See Also `java.lang.Comparable#compareTo(java.lang.Object)`

public int compareTo(Object o)

Overrides org.osgi.service.dal.FunctionData.compareTo.

Implements java.lang.Comparable.compareTo.

Compares this LevelData instance with the given argument. If the argument is not LevelData, it throws ClassCastException. Otherwise, this method returns:

-1 if this instance field is less than a field of the specified argument.
0 if all fields are equivalent.
1 if this instance field is greater than a field of the specified argument.

The fields are compared in this order: timestamp, metadata, level, unit.

Parameters

o:Object: LevelData to be compared.

Returns:int

-1, 0 or 1 depending on the comparison rules.

Annotations

@Override

Exceptions

ClassCastException:: If the method argument is not of type LevelData.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides org.osgi.service.dal.FunctionData.equals. Two `LevelData` instances are equal if they contain equal metadata, timestamp, unit and level. Parameters o:Object The object to compare this data. Returns:boolean `true` if this object is equivalent to the specified one. Annotations @Override See Also `org.osgi.service.dal.FunctionData#equals(java.lang.Object)`

public boolean equals(Object o)

Overrides org.osgi.service.dal.FunctionData.equals.

Two LevelData instances are equal if they contain equal metadata, timestamp, unit and level.

Parameters

o:Object: The object to compare this data.

Returns:boolean

true if this object is equivalent to the specified one.

Annotations

@Override

getLevel back to summary

getLevel	back to summary
public BigDecimal getLevel() Returns `LevelData` value. The value type is `BigDecimal` instead of `double` to guarantee value accuracy. Returns:BigDecimal The `LevelData` value.

public BigDecimal getLevel()

Returns LevelData value. The value type is BigDecimal instead of double to guarantee value accuracy.

Returns:BigDecimal: The LevelData value.

getUnit back to summary

getUnit	back to summary
public String getUnit() Returns `LevelData` unit as it's specified in `PropertyMetadata#UNITS` or `null` if the unit is missing. Returns:String The value unit or `null` if the unit is missing.

public String getUnit()

Returns LevelData unit as it's specified in PropertyMetadata#UNITS or null if the unit is missing.

Returns:String: The value unit or null if the unit is missing.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.osgi.service.dal.FunctionData.hashCode. Returns the hash code for this `LevelData` object. The hash code is a sum of `FunctionData#hashCode()`, `String#hashCode()` and `BigDecimal#hashCode()`, where `String#hashCode()` represents the unit hash code and `BigDecimal#hashCode()` represents the level hash code. Returns:int The hash code of this `LevelData` object. Annotations @Override See Also `org.osgi.service.dal.FunctionData#hashCode()`

public int hashCode()

Overrides org.osgi.service.dal.FunctionData.hashCode.

Returns the hash code for this LevelData object. The hash code is a sum of FunctionData#hashCode(), String#hashCode() and BigDecimal#hashCode(), where String#hashCode() represents the unit hash code and BigDecimal#hashCode() represents the level hash code.

Returns:int

The hash code of this LevelData object.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the string representation of this level data. Returns:String The string representation of this level data. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the string representation of this level data.

Returns:String

The string representation of this level data.

Annotations

@Override

public Class LevelData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail