io.relayr.java.storage

Class DeviceModelCache

java.lang.Object

io.relayr.java.storage.DeviceModelCache

@Singleton
public class DeviceModelCache
extends java.lang.Object

Caches all DeviceModel objects. Works only if there is Internet connection. Use DeviceModelCache to determine appropriate model for your device. Example: call getModelById(String) using modelId from Device.getModelId()

Constructor Summary

Constructors

Constructor and Description
DeviceModelCache(DeviceModelsApi modelsApi, UserApi userApi)

Method Summary

Modifier and Type	Method and Description
boolean	available()
java.util.List<DeviceModel>	getAll()
DeviceModel	getModelById(java.lang.String modelId) Returns DeviceModel depending on specified modelId.
DeviceModel	getModelByName(java.lang.String name) Returns DeviceModel depending on specified modelId.
DeviceModel	getModelByName(java.lang.String name, boolean equals) Returns DeviceModel depending on specified modelId.
DeviceModel	getModelByName(java.lang.String name, boolean equals, boolean caseSensitive) Returns DeviceModel depending on specified modelId.
boolean	isLoading() Returns cache state.
void	refresh() Refresh device model cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceModelCache

@Inject
public DeviceModelCache(DeviceModelsApi modelsApi,
                                UserApi userApi)

Method Detail

isLoading

public boolean isLoading()

Returns cache state. Use this method before using getModelById(String)

Returns:

true if cache is loading and it's not ready for use, false otherwise

available

public boolean available()

Returns:

true if models are cached, false otherwise

getModelById

public DeviceModel getModelById(java.lang.String modelId)
                         throws DeviceModelsException

Returns DeviceModel depending on specified modelId. Obtain modelId parameter from Device.getModelId()

Parameters:

modelId - Device.getModelId()

Returns:

DeviceModel if one is found, null otherwise

Throws:

DeviceModelsException

getModelByName

public DeviceModel getModelByName(java.lang.String name)
                           throws DeviceModelsCacheException

Returns DeviceModel depending on specified modelId. Search is NOT case sensitive and matches the results with equals.

Parameters:

name - model name

Returns:

DeviceModel if one is found, null otherwise

Throws:

DeviceModelsCacheException

getModelByName

public DeviceModel getModelByName(java.lang.String name,
                                  boolean equals)
                           throws DeviceModelsCacheException

Returns DeviceModel depending on specified modelId. This search is NOT case sensitive.

Parameters:

name - model name

equals - if true names will be matched only if they are equal

Returns:

DeviceModel if one is found, null otherwise

Throws:

DeviceModelsCacheException

getModelByName

public DeviceModel getModelByName(java.lang.String name,
                                  boolean equals,
                                  boolean caseSensitive)
                           throws DeviceModelsCacheException

Returns DeviceModel depending on specified modelId.

Parameters:

name - model name

equals - if true names will be matched only if they are equal

caseSensitive - true if matching should be case sensitive

Returns:

DeviceModel if one is found, null otherwise

Throws:

DeviceModelsCacheException

getAll

public java.util.List<DeviceModel> getAll()
                                   throws DeviceModelsCacheException

Returns:

list of all DeviceModel supported on Relayr platform ordered by name.

Throws:

DeviceModelsCacheException

refresh

public void refresh()

Refresh device model cache.