Device (anoa-tests 3.1.2 API)

All Superinterfaces:

Comparable<Device<?>>, Serializable, Supplier<T>

All Known Implementing Classes:

Device.Avro, Device.NativeImpl, Device.Protobuf, Device.Thrift
```
public interface Device<T>
extends Supplier<T>, Comparable<Device<?>>, Serializable
```
3.3.10 Device Object The “device” object provides information pertaining to the device including its hardware, platform, location, and carrier. This device can refer to a mobile handset, a desktop computer, set top box or other digital device. The device object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown. In general, the most essential fields are either the IP address (to enable geo-lookup for the bidder), or providing geo information directly in the geo object.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Device.Avro`
`static class`	`Device.AvroBuilder`
`static interface`	`Device.Builder<T>`
`static class`	`Device.Comparator`
`static class`	`Device.NativeImpl`
`static class`	`Device.Protobuf`
`static class`	`Device.ProtobufBuilder`
`static class`	`Device.Thrift`
`static class`	`Device.ThriftBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Device.Avro`	`avro(Device<?> instance)` Returns a wrapped Avro record based on an instance of Device.
`static Device.Avro`	`avro(DeviceAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Device<?> other)`
`T`	`get()` Returns underlying object.
`static Class<DeviceAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`String`	`getCarrier()` Carrier or ISP derived from the IP address.
`static Comparator<Device<?>>`	`getComparator()` Returns comparator instance for Device objects.
`int`	`getConnectiontype()` Return the detected data connection type for the device.
`int`	`getDevicetype()` Return the device type being used.
`String`	`getDidmd5()` MD5 hashed device ID; IMEI when available, else MEID or ESN.
`String`	`getDidsha1()` SHA1 hashed device ID; IMEI when available, else MEID or ESN.
`int`	`getDnt()` If “0”, then do not track Is set to false, if “1”, then do no track is set to true in browser.
`String`	`getDpidmd5()` MD5 hashed platform-specific ID (e.g., Android ID or UDID for iOS).
`String`	`getDpidsha1()` SHA1 hashed platform-specific ID (e.g., Android ID or UDID for iOS).
`String`	`getFlashver()` Return the Flash version detected.
`Geo<?>`	`getGeo()` Geography as derived from the device’s location services (e.g., cell tower triangulation, GPS) or IP address.
`String`	`getIfa()` Native identifier for advertisers; an opaque ID assigned by the device or browser for use as an advertising identifier.
`String`	`getIp()` IPv4 address closest to device.
`String`	`getIpv6()` IP address in IPv6.
`int`	`getJs()` “1” if the device supports JavaScript; else “0”.
`String`	`getLanguage()` Browser language; use alpha-2/ISO 639-1 codes.
`String`	`getMacmd5()` MD5 hashed MAC address of the device.
`String`	`getMacsha1()` SHA1 hashed MAC address of the device.
`String`	`getMake()` Device make (e.g., “Apple”).
`String`	`getModel()` Device model (e.g., “iPhone”).
`String`	`getOs()` Device operating system (e.g., “iOS”).
`String`	`getOsv()` Device operating system version (e.g., “3.1.2”).
`static Class<OpenRtbProtobuf.Device>`	`getProtobufClass()` Returns Protobuf class for this struct.
`static com.google.protobuf.Descriptors.Descriptor`	`getProtobufDescriptor()` Returns Protobuf descriptor for this struct.
`static Class<AdExchangeProtobuf>`	`getProtobufProtocolClass()` Returns Protobuf protocol class for this struct.
`static com.google.protobuf.Descriptors.FileDescriptor`	`getProtobufProtocolDescriptor()` Returns Protobuf protocol descriptor for this struct.
`static Class<DeviceThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<DeviceThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`String`	`getUa()` Browser user agent string.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultCarrier()`
`boolean`	`isDefaultConnectiontype()`
`boolean`	`isDefaultDevicetype()`
`boolean`	`isDefaultDidmd5()`
`boolean`	`isDefaultDidsha1()`
`boolean`	`isDefaultDnt()`
`boolean`	`isDefaultDpidmd5()`
`boolean`	`isDefaultDpidsha1()`
`boolean`	`isDefaultFlashver()`
`boolean`	`isDefaultGeo()`
`boolean`	`isDefaultIfa()`
`boolean`	`isDefaultIp()`
`boolean`	`isDefaultIpv6()`
`boolean`	`isDefaultJs()`
`boolean`	`isDefaultLanguage()`
`boolean`	`isDefaultMacmd5()`
`boolean`	`isDefaultMacsha1()`
`boolean`	`isDefaultMake()`
`boolean`	`isDefaultModel()`
`boolean`	`isDefaultOs()`
`boolean`	`isDefaultOsv()`
`boolean`	`isDefaultUa()`
`static Device.NativeImpl`	`nativeImpl(Device<?> instance)` Returns a POJO based on an instance of Device.
`static Device.Builder<DeviceAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Device.Builder<DeviceAvro>`	`newAvroBuilder(Device<?> other)` Returns new Avro builder instance based on existing prototype Device.
`static Device.Builder<DeviceAvro>`	`newAvroBuilder(DeviceAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Device.Builder<DeviceAvro>`	`newAvroBuilder(DeviceAvro other)` Returns new Avro builder instance based on existing prototype.
`Device.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Device.Builder<Device.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Device.Builder<Device.NativeImpl>`	`newNativeImplBuilder(Device<?> other)` Returns a POJO builder instance based on existing prototype Device.
`static Device.Builder<OpenRtbProtobuf.Device>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Device.Builder<OpenRtbProtobuf.Device>`	`newProtobufBuilder(Device<?> other)` Returns new Protobuf builder instance based on existing prototype Device.
`static Device.Builder<OpenRtbProtobuf.Device>`	`newProtobufBuilder(OpenRtbProtobuf.Device other)` Returns new Protobuf builder instance based on existing prototype.
`static Device.Builder<DeviceThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Device.Builder<DeviceThrift>`	`newThriftBuilder(Device<?> other)` Returns new Thrift builder instance based on existing prototype Device.
`static Device.Builder<DeviceThrift>`	`newThriftBuilder(DeviceThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Device.Protobuf`	`protobuf(Device<?> instance)` Returns a wrapped Protobuf message based on an instance of Device.
`static Device.Protobuf`	`protobuf(OpenRtbProtobuf.Device wrapped)` Wraps an existing Protobuf message.
`static Device.Thrift`	`thrift(Device<?> instance)` Returns a wrapped Thrift struct based on an instance of Device.
`static Device.Thrift`	`thrift(DeviceThrift instance)` Creates a new wrapped Thrift struct copied from an existing instance.

- Method Detail
  - isDefault
```
default boolean isDefault()
```
    True if all fields are set to default values.
  - get
```
T get()
```
    Returns underlying object.
    
    Specified by:
    
    get in interface Supplier<T>
  - newBuilder
```
Device.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getDnt
```
int getDnt()
```
    If “0”, then do not track Is set to false, if “1”, then do no track is set to true in browser.
  - isDefaultDnt
```
boolean isDefaultDnt()
```
  - getUa
```
String getUa()
```
    Browser user agent string.
  - isDefaultUa
```
boolean isDefaultUa()
```
  - getIp
```
String getIp()
```
    IPv4 address closest to device.
  - isDefaultIp
```
boolean isDefaultIp()
```
  - getGeo
```
Geo<?> getGeo()
```
    Geography as derived from the device’s location services (e.g., cell tower triangulation, GPS) or IP address. See Geo Object.
  - isDefaultGeo
```
boolean isDefaultGeo()
```
  - getDidsha1
```
String getDidsha1()
```
    SHA1 hashed device ID; IMEI when available, else MEID or ESN. OpenRTB’s preferred method for device ID hashing is SHA1.
  - isDefaultDidsha1
```
boolean isDefaultDidsha1()
```
  - getDidmd5
```
String getDidmd5()
```
    MD5 hashed device ID; IMEI when available, else MEID or ESN. Should be interpreted as case insensitive.
  - isDefaultDidmd5
```
boolean isDefaultDidmd5()
```
  - getDpidsha1
```
String getDpidsha1()
```
    SHA1 hashed platform-specific ID (e.g., Android ID or UDID for iOS). OpenRTB’s preferred method for device ID hash is SHA1.
  - isDefaultDpidsha1
```
boolean isDefaultDpidsha1()
```
  - getDpidmd5
```
String getDpidmd5()
```
    MD5 hashed platform-specific ID (e.g., Android ID or UDID for iOS). Should be interpreted as case insensitive.
  - isDefaultDpidmd5
```
boolean isDefaultDpidmd5()
```
  - getMacsha1
```
String getMacsha1()
```
    SHA1 hashed MAC address of the device.
  - isDefaultMacsha1
```
boolean isDefaultMacsha1()
```
  - getMacmd5
```
String getMacmd5()
```
    MD5 hashed MAC address of the device.
  - isDefaultMacmd5
```
boolean isDefaultMacmd5()
```
  - getIpv6
```
String getIpv6()
```
    IP address in IPv6.
  - isDefaultIpv6
```
boolean isDefaultIpv6()
```
  - getCarrier
```
String getCarrier()
```
    Carrier or ISP derived from the IP address. Should be specified using Mobile Network Code (MNC) http://en.wikipedia.org/wiki/Mobile_Network_Code
  - isDefaultCarrier
```
boolean isDefaultCarrier()
```
  - getLanguage
```
String getLanguage()
```
    Browser language; use alpha-2/ISO 639-1 codes.
  - isDefaultLanguage
```
boolean isDefaultLanguage()
```
  - getMake
```
String getMake()
```
    Device make (e.g., “Apple”).
  - isDefaultMake
```
boolean isDefaultMake()
```
  - getModel
```
String getModel()
```
    Device model (e.g., “iPhone”).
  - isDefaultModel
```
boolean isDefaultModel()
```
  - getOs
```
String getOs()
```
    Device operating system (e.g., “iOS”).
  - isDefaultOs
```
boolean isDefaultOs()
```
  - getOsv
```
String getOsv()
```
    Device operating system version (e.g., “3.1.2”).
  - isDefaultOsv
```
boolean isDefaultOsv()
```
  - getJs
```
int getJs()
```
    “1” if the device supports JavaScript; else “0”.
  - isDefaultJs
```
boolean isDefaultJs()
```
  - getConnectiontype
```
int getConnectiontype()
```
    Return the detected data connection type for the device. See Table 6.10 Connection Type.
  - isDefaultConnectiontype
```
boolean isDefaultConnectiontype()
```
  - getDevicetype
```
int getDevicetype()
```
    Return the device type being used. See Table 6.16 Device Type.
  - isDefaultDevicetype
```
boolean isDefaultDevicetype()
```
  - getFlashver
```
String getFlashver()
```
    Return the Flash version detected.
  - isDefaultFlashver
```
boolean isDefaultFlashver()
```
  - getIfa
```
String getIfa()
```
    Native identifier for advertisers; an opaque ID assigned by the device or browser for use as an advertising identifier. (e.g. Apple's IFA, Android's Advertising ID, etc)
  - isDefaultIfa
```
boolean isDefaultIfa()
```
  - getComparator
```
static Comparator<Device<?>> getComparator()
```
    Returns comparator instance for Device objects.
  - compareTo
```
default int compareTo(Device<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Device<?>>
  - newNativeImplBuilder
```
static Device.Builder<Device.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Device.Builder<Device.NativeImpl> newNativeImplBuilder(Device<?> other)
```
    Returns a POJO builder instance based on existing prototype Device.
  - nativeImpl
```
static Device.NativeImpl nativeImpl(Device<?> instance)
```
    Returns a POJO based on an instance of Device.
  - newAvroBuilder
```
static Device.Builder<DeviceAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Device.Builder<DeviceAvro> newAvroBuilder(DeviceAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Device.Builder<DeviceAvro> newAvroBuilder(DeviceAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Device.Builder<DeviceAvro> newAvroBuilder(Device<?> other)
```
    Returns new Avro builder instance based on existing prototype Device.
  - avro
```
static Device.Avro avro(Device<?> instance)
```
    Returns a wrapped Avro record based on an instance of Device.
  - avro
```
static Device.Avro avro(DeviceAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<DeviceAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Device.Builder<OpenRtbProtobuf.Device> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Device.Builder<OpenRtbProtobuf.Device> newProtobufBuilder(OpenRtbProtobuf.Device other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Device.Builder<OpenRtbProtobuf.Device> newProtobufBuilder(Device<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Device.
  - protobuf
```
static Device.Protobuf protobuf(Device<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Device.
  - protobuf
```
static Device.Protobuf protobuf(OpenRtbProtobuf.Device wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Device> getProtobufClass()
```
    Returns Protobuf class for this struct.
  - getProtobufProtocolClass
```
static Class<AdExchangeProtobuf> getProtobufProtocolClass()
```
    Returns Protobuf protocol class for this struct.
  - getProtobufDescriptor
```
static com.google.protobuf.Descriptors.Descriptor getProtobufDescriptor()
```
    Returns Protobuf descriptor for this struct.
  - getProtobufProtocolDescriptor
```
static com.google.protobuf.Descriptors.FileDescriptor getProtobufProtocolDescriptor()
```
    Returns Protobuf protocol descriptor for this struct.
  - newThriftBuilder
```
static Device.Builder<DeviceThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Device.Builder<DeviceThrift> newThriftBuilder(DeviceThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Device.Builder<DeviceThrift> newThriftBuilder(Device<?> other)
```
    Returns new Thrift builder instance based on existing prototype Device.
  - thrift
```
static Device.Thrift thrift(Device<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Device.
  - thrift
```
static Device.Thrift thrift(DeviceThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<DeviceThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<DeviceThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Device<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getDnt

isDefaultDnt

getUa

isDefaultUa

getIp

isDefaultIp

getGeo

isDefaultGeo

getDidsha1

isDefaultDidsha1

getDidmd5

isDefaultDidmd5

getDpidsha1

isDefaultDpidsha1

getDpidmd5

isDefaultDpidmd5

getMacsha1

isDefaultMacsha1

getMacmd5

isDefaultMacmd5

getIpv6

isDefaultIpv6

getCarrier

isDefaultCarrier

getLanguage

isDefaultLanguage

getMake

isDefaultMake

getModel

isDefaultModel

getOs

isDefaultOs

getOsv

isDefaultOsv

getJs

isDefaultJs

getConnectiontype

isDefaultConnectiontype

getDevicetype

isDefaultDevicetype

getFlashver

isDefaultFlashver

getIfa

isDefaultIfa

getComparator

compareTo

newNativeImplBuilder

newNativeImplBuilder

nativeImpl

newAvroBuilder

newAvroBuilder

newAvroBuilder

newAvroBuilder

avro

avro

getAvroClass

getAvroSchema

newProtobufBuilder

newProtobufBuilder

newProtobufBuilder

protobuf

protobuf

getProtobufClass

getProtobufProtocolClass

getProtobufDescriptor

getProtobufProtocolDescriptor

newThriftBuilder

newThriftBuilder

newThriftBuilder

thrift

thrift

getThriftClass

getThriftMetadataMap