Index

A B C D E F G H I J L M N P S T U V

A

Api - Class in mobi.mtld.da: Deprecated.
This API is deprecated, it is highly recommended to use the new "mobi.mtld.da.device.DeviceApi" instead. See DeviceApi
Api() - Constructor for class mobi.mtld.da.Api: Deprecated.
API_VERSION - Static variable in class mobi.mtld.da.device.DeviceApi: Api version
asBoolean() - Method in class mobi.mtld.da.Property: Get the value of the property as a boolean.
asInteger() - Method in class mobi.mtld.da.Property: Get the value of the property as an int.
asSet() - Method in class mobi.mtld.da.Property: Gets a set of possible values for this property.
asString() - Method in class mobi.mtld.da.Property: Get the value of the property as a String.

B

BAD_DATA - Static variable in exception mobi.mtld.da.exception.JsonException: The data stored in the JSON cannot be used to build a valid DeviceAtlas data tree.
BOOLEAN - Static variable in class mobi.mtld.da.DataType: Type boolean
BYTE - Static variable in class mobi.mtld.da.DataType: Type byte

C

ClientPropertiesException - Exception in mobi.mtld.da.exception: The ClientPropertiesException is thrown by the API when there is a problem parsing the properties from the client or when the JSON file does not support client side properties.
ClientPropertiesException(String) - Constructor for exception mobi.mtld.da.exception.ClientPropertiesException: Constructs a JsonException instance with a code and human-readable message.
ClientPropertiesException(String, Throwable) - Constructor for exception mobi.mtld.da.exception.ClientPropertiesException: Constructs a JsonException instance with a code and human-readable message.
Config - Class in mobi.mtld.da.device: DeviceApi Configurations.
Config() - Constructor for class mobi.mtld.da.device.Config
contains(String, T) - Method in class mobi.mtld.da.Properties: Check if a property has a specific value.

D

DataFileException - Exception in mobi.mtld.da.exception: The DataFileException is thrown if there is a problem loading the data file.
DataFileException(String) - Constructor for exception mobi.mtld.da.exception.DataFileException
DataFileException(String, Exception) - Constructor for exception mobi.mtld.da.exception.DataFileException
DataReadException - Exception in mobi.mtld.da.exception: The DataReadException is thrown if there is a problem loading the data from stream.
DataReadException(String) - Constructor for exception mobi.mtld.da.exception.DataReadException
DataReadException(String, Exception) - Constructor for exception mobi.mtld.da.exception.DataReadException
DataType - Class in mobi.mtld.da: The data types for various properties.
DataType() - Constructor for class mobi.mtld.da.DataType
DEFAULT_COOKIE_NAME - Static variable in class mobi.mtld.da.device.Config: The default cookie name that the client side properties would be set to.
DEFAULT_INCLUDE_LANG_PROPS - Static variable in class mobi.mtld.da.device.Config: The default config value for getProperties(HEADERS) or getProperties(REQUEST) to check the Accept-Language header and include properties to the property set for getting client's language and locale preferences.
DEFAULT_INCLUDE_MATCH_INFO - Static variable in class mobi.mtld.da.device.Config: The default config value for getProperties() to include the matched and unmatched parts of the User-Agent to the property set.
DEFAULT_INCLUDE_UA_PROPS - Static variable in class mobi.mtld.da.device.Config: The default config value for getProperties() to include User-Agent dynamic properties.
DEFAULT_RETURN_NULL_WHEN_NO_PROPERTIES - Static variable in class mobi.mtld.da.device.Config: The default config value for getProperties() return value when there was no properties.
DeviceApi - Class in mobi.mtld.da.device: The DeviceAtlas device detection API provides a way to detect devices based on the HTTP headers.
DeviceApi() - Constructor for class mobi.mtld.da.device.DeviceApi: Constructs a DeviceApi instance with default configs.
DeviceApi(Config) - Constructor for class mobi.mtld.da.device.DeviceApi: Constructs a DeviceApi instance with custom configs.
DeviceApiWeb - Class in mobi.mtld.da.device: A small extension to the core DeviceApi to permit passing of an HttpServletRequest object.
DeviceApiWeb() - Constructor for class mobi.mtld.da.device.DeviceApiWeb: Constructs a DeviceApiWeb instance with default configs.
DeviceApiWeb(Config) - Constructor for class mobi.mtld.da.device.DeviceApiWeb: Constructs a DeviceApiWeb instance with custom configs.
DOUBLE - Static variable in class mobi.mtld.da.DataType: Type double

E

equals(Object) - Method in class mobi.mtld.da.Property
equals(Object) - Method in class mobi.mtld.da.PropertyName

F

FILE_NOT_FOUND_ERROR - Static variable in exception mobi.mtld.da.exception.JsonException: The path to the JSON file that was given cannot be resolved.
FLOAT - Static variable in class mobi.mtld.da.DataType: Type float

G

getApiRevision() - Static method in class mobi.mtld.da.Api: Deprecated.

Returns the revision number of this API
getApiVersion() - Static method in class mobi.mtld.da.device.DeviceApi: Get DeviceApi version.
getCause() - Method in exception mobi.mtld.da.exception.ClientPropertiesException: Retrieves the throwable, which determines the nature/cause of the exception.
getCause() - Method in exception mobi.mtld.da.exception.IncorrectPropertyTypeException
getCause() - Method in exception mobi.mtld.da.exception.InvalidPropertyException
getCause() - Method in exception mobi.mtld.da.exception.JsonException: Retrieves the throwable, which determines the nature/cause of the exception.
getCause() - Method in exception mobi.mtld.da.exception.UnknownPropertyException
getCode() - Method in exception mobi.mtld.da.exception.JsonException: Retrieves the exception code, which determines the nature/cause of the exception.
getCookieName() - Method in class mobi.mtld.da.device.Config: Get the cookie name that the client side properties would be set to.
getDataCreationTimestamp() - Method in class mobi.mtld.da.device.DeviceApi: Get the device data creation (JSON file) timestamp.
getDataRevision() - Method in class mobi.mtld.da.device.DeviceApi: Get the device data generation revision.
getDataType() - Method in class mobi.mtld.da.Property: Get the data type name for values associated with this Property
getDataType() - Method in class mobi.mtld.da.PropertyName: Get the data type name for values associated with this Property name.
getDataTypeId() - Method in class mobi.mtld.da.Property: Get the data type ID for values associated with this Property
getDataTypeId() - Method in class mobi.mtld.da.PropertyName: Get the data type ID for values associated with this Property name.
getDataVersion() - Method in class mobi.mtld.da.device.DeviceApi: Get the device data (JSON file) version.
getIncludeLangProps() - Method in class mobi.mtld.da.device.Config: Get if the language/locale properties are being included in the property set or not.
getIncludeMatchInfo() - Method in class mobi.mtld.da.device.Config: To get if getProperties() include the matched and unmatched parts of the User-Agent to the property set.
getIncludeUaProps() - Method in class mobi.mtld.da.device.Config: Get if the User-Agent properties are being included in the property set or not.
getName(byte) - Static method in class mobi.mtld.da.DataType: Get the name of a given data type.
getName() - Method in class mobi.mtld.da.PropertyName: Get the name of this PropertyName
getProperties(HashMap, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a HashMap of known properties (as strings) for the user agent
getProperties(HashMap, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a HashMap of known properties merged with properties from the client side JavaScript.
getProperties(String) - Method in class mobi.mtld.da.device.DeviceApi: Get the properties for a User-Agent.
getProperties(String, String) - Method in class mobi.mtld.da.device.DeviceApi: Get the properties for a User-Agent merged with the client-side properties (provided by the DeviceAtlas client side component).
getProperties(Map<String, String>) - Method in class mobi.mtld.da.device.DeviceApi: Get the properties for a set of HTTP headers.
getProperties(Map<String, String>, String) - Method in class mobi.mtld.da.device.DeviceApi: Get the properties for a set of HTTP headers merged with properties from the client side component.
getProperties(HttpServletRequest) - Method in class mobi.mtld.da.device.DeviceApiWeb: Get the Device properties for the given HttpServletRequest object.
getPropertiesAsTyped(HashMap, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a HashMap of known properties (as typed) for the user agent
getPropertiesAsTyped(HashMap, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a HashMap of known properties merged with properties from the client side JavaScript.
getProperty(HashMap, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a value for the named property for this user agent
getProperty(HashMap, String, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a value for the named property for this user agent
getPropertyAsBoolean(HashMap, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Strongly typed property accessor.
getPropertyAsBoolean(HashMap, String, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Strongly typed property accessor.
getPropertyAsDate(HashMap, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.
getPropertyAsDate(HashMap, String, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.
getPropertyAsInteger(HashMap, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Strongly typed property accessor.
getPropertyAsInteger(HashMap, String, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Strongly typed property accessor.
getPropertyAsString(HashMap, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Strongly typed property accessor.
getPropertyAsString(HashMap, String, String, String) - Static method in class mobi.mtld.da.Api: Deprecated.

Strongly typed property accessor.
getPropertyNames() - Method in class mobi.mtld.da.device.DeviceApi: Get a set of all possible property names.
getReturnNullWhenNoProperties() - Method in class mobi.mtld.da.device.Config: Get if the value returned by getProperties() should be null when there are no properties to return or an instance of Properties that has no Property inside it should be returned.
getTreeFromFile(String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a tree from a JSON file, If it has been previously loaded then the version from the static cache will be returned.
getTreeFromFile(String, boolean) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a tree from a JSON file.
getTreeFromFile(String, boolean, boolean) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a tree from a JSON file.
getTreeFromString(String) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a loaded JSON tree from a string of JSON data.
getTreeFromString(String, boolean) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a loaded JSON tree from a string of JSON data.
getTreeGeneration(HashMap) - Static method in class mobi.mtld.da.Api: Deprecated.

Get the generation date for this tree.
getTreeGenerationAsTimestamp(HashMap) - Static method in class mobi.mtld.da.Api: Deprecated.

Get the generation date for this tree as a UNIX timestamp.
getTreeRevision(HashMap) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns the revision number of the tree

H

hashCode() - Method in class mobi.mtld.da.Property
hashCode() - Method in class mobi.mtld.da.PropertyName

I

IncorrectPropertyTypeException - Exception in mobi.mtld.da.exception: The InvalidPropertyException is thrown by the Api class when there is an attemp to fetch a property by type and the property is stored under a different type in the tree.
IncorrectPropertyTypeException(String) - Constructor for exception mobi.mtld.da.exception.IncorrectPropertyTypeException: Constructs a UnknownPropertyException with a message.
IncorrectPropertyTypeException(Throwable) - Constructor for exception mobi.mtld.da.exception.IncorrectPropertyTypeException
INTEGER - Static variable in class mobi.mtld.da.DataType: Type int
InvalidPropertyException - Exception in mobi.mtld.da.exception: The InvalidPropertyException is thrown by the Api class when there is an attemp to fetch a property that is unknown for the supplied user agent.
InvalidPropertyException(String) - Constructor for exception mobi.mtld.da.exception.InvalidPropertyException: Constructs a UnknownPropertyException with a message.
InvalidPropertyException(Throwable) - Constructor for exception mobi.mtld.da.exception.InvalidPropertyException
InvalidPropertyNameException - Exception in mobi.mtld.da.exception: The InvalidPropertyNameException is thrown when an attempt is made to get a property using a property name that does not exist.
InvalidPropertyNameException(String) - Constructor for exception mobi.mtld.da.exception.InvalidPropertyNameException

J

JSON_VERSION - Static variable in exception mobi.mtld.da.exception.JsonException: The JSON data you are using is too old for this API.
JsonException - Exception in mobi.mtld.da.exception: The JsonException is thrown by the Json class or the Api class when there is an error parsing the Json.
JsonException(int, String) - Constructor for exception mobi.mtld.da.exception.JsonException: Constructs a JsonException instance with a code and human-readable message.

L

listProperties(HashMap) - Static method in class mobi.mtld.da.Api: Deprecated.

Returns a HashMap of known property names available for the user agents in this file, with their data type names
loadDataFromClassPath(String) - Method in class mobi.mtld.da.device.DeviceApi: Load the DeviceAtlas device detection data into the API from a JSON file form the class path.
loadDataFromFile(String) - Method in class mobi.mtld.da.device.DeviceApi: Load the DeviceAtlas device detection data into the API from a JSON file.
loadDataFromStream(InputStream) - Method in class mobi.mtld.da.device.DeviceApi: Load the DeviceAtlas device detection data into the API from an input stream.
LONG - Static variable in class mobi.mtld.da.DataType: Type long int

M

MissingDataException - Exception in mobi.mtld.da.exception: The MissingDataException is thrown if a data file was not loaded before a call to methods like getProperties(String ip) or getPropertyNames();
MissingDataException(String) - Constructor for exception mobi.mtld.da.exception.MissingDataException
MissingDataException(String, Exception) - Constructor for exception mobi.mtld.da.exception.MissingDataException
mobi.mtld.da - package mobi.mtld.da: Common classes for the various DeviceAtlas APIs.
mobi.mtld.da.device - package mobi.mtld.da.device: The main package for the Device API.
mobi.mtld.da.exception - package mobi.mtld.da.exception: Common exceptions for DeviceAtlas APIs.

N

NO_CLIENT_PROPERTIES_SECTION - Static variable in exception mobi.mtld.da.exception.JsonException: The JSON file does not contain the Client Properties Section.

P

Properties - Class in mobi.mtld.da: Map String property names to Property objects.
Properties() - Constructor for class mobi.mtld.da.Properties
Property - Class in mobi.mtld.da: Contains a property value.
Property(Object, byte) - Constructor for class mobi.mtld.da.Property: Create a new Property with a value and data type.
Property(Object, char) - Constructor for class mobi.mtld.da.Property: Create a new Property with a value and data type.
Property(Object, byte, boolean) - Constructor for class mobi.mtld.da.Property
PropertyName - Class in mobi.mtld.da: Contains a property name and the expected data type of values associated with this name.
PropertyName(String, byte) - Constructor for class mobi.mtld.da.PropertyName: Create a new PropertyName with string name and expected data type of values.

S

setCookieName(String) - Method in class mobi.mtld.da.device.Config: To change the cookie name that the client side properties would be set to.
setIncludeLangProps(boolean) - Method in class mobi.mtld.da.device.Config: To disable or enable getProperties(HEADERS) or getProperties(REQUEST) including language and locale properties.
setIncludeMatchInfo(boolean) - Method in class mobi.mtld.da.device.Config: To disable or enable getProperties() including the matched and unmatched parts of the User-Agent to the property set.
setIncludeUaProps(boolean) - Method in class mobi.mtld.da.device.Config: To disable or enable getProperties() including User-Agent dynamic properties.
setReturnNullWhenNoProperties(boolean) - Method in class mobi.mtld.da.device.Config: Set if the value returned by the getProperties() method should be null when there are no properties to return or whether an empty Properties object should be returned instead.
SHORT - Static variable in class mobi.mtld.da.DataType: Type short int
STRING - Static variable in class mobi.mtld.da.DataType: Type string

T

toString() - Method in class mobi.mtld.da.Property: Get the value of the property as a String.
toString() - Method in class mobi.mtld.da.PropertyName: Get the property name and the data type as "property-name (property-data-type)"

U

UNKNOWN - Static variable in class mobi.mtld.da.DataType: Unknown type
UnknownPropertyException - Exception in mobi.mtld.da.exception: The UnknownPropertyException is thrown by the Api class when there is an attemp to fetch a property unknown to the tree.
UnknownPropertyException(String) - Constructor for exception mobi.mtld.da.exception.UnknownPropertyException: Constructs a UnknownPropertyException with a message.
UnknownPropertyException(Throwable) - Constructor for exception mobi.mtld.da.exception.UnknownPropertyException

V

value() - Method in class mobi.mtld.da.Property: Get the value Object.

A B C D E F G H I J L M N P S T U V