com.oracle.iot.client

Class DeviceModelAttribute<T>

java.lang.Object

com.oracle.iot.client.DeviceModelAttribute<T>

Type Parameters:

T - the type of value

public abstract class DeviceModelAttribute<T>
extends java.lang.Object

DeviceModelAttribute is the model of an attribute in a DeviceModel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceModelAttribute.Access Access rules for an attribute.
static class	DeviceModelAttribute.Type An enumeration of the data types an attribute may contain.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeviceModelAttribute()

Method Summary

Modifier and Type	Method and Description
abstract DeviceModelAttribute.Access	getAccess() Return the access rules for the attribute.
abstract java.lang.String	getAlias() Deprecated. Use getName()
T	getDefaultValue() Get the default value of the attribute as defined by the device model.
abstract java.lang.String	getDescription() A human friendly description of the attribute.
abstract java.lang.Number	getLowerBound() For DeviceModelAttribute.Type.NUMBER only, give the lower bound of the acceptable range of values.
abstract java.lang.String	getModel() Get the URN of the device type model this attribute comes from.
abstract java.lang.String	getName() Get the attribute name.
abstract DeviceModelAttribute.Type	getType() The data type of the attribute.
abstract java.lang.Number	getUpperBound() For DeviceModelAttribute.Type.NUMBER only, give the upper bound of the acceptable range of values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceModelAttribute

protected DeviceModelAttribute()

Method Detail

getName

public abstract java.lang.String getName()

Get the attribute name.

Returns:

the attribute name from the device model

getModel

public abstract java.lang.String getModel()

Get the URN of the device type model this attribute comes from.

Returns:

the URN of the device type model

getDescription

public abstract java.lang.String getDescription()

A human friendly description of the attribute. If the model does not contain a description, this method will return an empty String.

Returns:

the attribute description, or an empty string

getType

public abstract DeviceModelAttribute.Type getType()

The data type of the attribute. If the access type of the attribute is executable, this method will return null.

Returns:

the attribute's data type, or null

getLowerBound

public abstract java.lang.Number getLowerBound()

For DeviceModelAttribute.Type.NUMBER only, give the lower bound of the acceptable range of values. Null is always returned for attributes other than NUMBER type.

Returns:

a Number, or null if no lower bound has been set

getUpperBound

public abstract java.lang.Number getUpperBound()

For DeviceModelAttribute.Type.NUMBER only, give the upper bound of the acceptable range of values. Null is always returned for attributes other than NUMBER type.

Returns:

a Number, or null if no upper bound has been set

getAccess

public abstract DeviceModelAttribute.Access getAccess()

Return the access rules for the attribute. The default is READ-ONLY

Returns:

the access rule for the attribute

getAlias

@Deprecated
public abstract java.lang.String getAlias()

Deprecated. Use getName()

Returns:

an alternative name for the attribute

getDefaultValue

public T getDefaultValue()

Get the default value of the attribute as defined by the device model. If there is no defaultValue for the attribute in the device model, then this method will return null. The value null is not a default value.

Returns:

the default value of the attribute, or null if no default is defined