Package com.lucimber.dbus.type

Class DBusDict<KeyT extends DBusBasicType,ValueT extends DBusType>

java.lang.Object

com.lucimber.dbus.type.DBusDict<KeyT,ValueT>

Type Parameters:

KeyT - The key's data type.

ValueT - The value's data type.

All Implemented Interfaces:

DBusContainerType, DBusType, Map<KeyT,ValueT>

public final class DBusDict<KeyT extends DBusBasicType,ValueT extends DBusType>
extends Object
implements Map<KeyT,ValueT>, DBusContainerType

An object that maps keys to values.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
DBusDict(DBusDict<KeyT,ValueT> other)	Constructs a new instance from another.
DBusDict(DBusSignature signature)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<DBusDictEntry<KeyT,ValueT>>	dictionaryEntrySet()	Returns a set view of the mappings contained in this map.
Set<Map.Entry<KeyT,ValueT>>	entrySet()
static DBusDict<DBusString,DBusString>	fromStringMap(Map<String,String> map)	Creates a dictionary with string keys and string values from a Java Map.
static DBusDict<DBusString,DBusVariant>	fromVariantMap(Map<String,Object> map)	Creates a dictionary with string keys and variant values from a Java Map.
ValueT	get(Object key)
Map<KeyT,ValueT>	getDelegate()	Gets the wrapped value of this container type.
DBusSignature	getSignature()	Gets the signature of this container type.
Type	getType()	Gets the type of this implementation.
boolean	isEmpty()
Set<KeyT>	keySet()
static DBusDict<DBusInt32,DBusString>	ofInt32ToString()	Creates a dictionary with int32 keys and string values.
static DBusDict<DBusObjectPath,DBusString>	ofObjectPathToString()	Creates a dictionary with object path keys and string values.
static DBusDict<DBusString,DBusBoolean>	ofStringToBoolean()	Creates a dictionary with string keys and boolean values.
static DBusDict<DBusString,DBusInt32>	ofStringToInt32()	Creates a dictionary with string keys and int32 values.
static DBusDict<DBusString,DBusInt64>	ofStringToInt64()	Creates a dictionary with string keys and int64 values.
static DBusDict<DBusString,DBusString>	ofStringToString()	Creates a dictionary with string keys and string values.
static DBusDict<DBusString,DBusVariant>	ofStringToVariant()	Creates a dictionary with string keys and variant values.
ValueT	put(KeyT key, ValueT value)
void	putAll(Map<? extends KeyT,? extends ValueT> m)
ValueT	remove(Object key)
int	size()
String	toString()
Collection<ValueT>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

DBusDict

public DBusDict(DBusSignature signature)

Constructs a new instance.

Parameters:

signature - a DBusSignature; must describe a dictionary

DBusDict

public DBusDict(DBusDict<KeyT,ValueT> other)

Constructs a new instance from another.

Parameters:

other - a DBusDict

Method Details

ofStringToString

public static DBusDict<DBusString,DBusString> ofStringToString()

Creates a dictionary with string keys and string values.

Returns:

a new empty DBusDict with string keys and values

ofStringToVariant

public static DBusDict<DBusString,DBusVariant> ofStringToVariant()

Creates a dictionary with string keys and variant values.

Returns:

a new empty DBusDict with string keys and variant values

ofStringToInt32

public static DBusDict<DBusString,DBusInt32> ofStringToInt32()

Creates a dictionary with string keys and int32 values.

Returns:

a new empty DBusDict with string keys and int32 values

ofStringToInt64

public static DBusDict<DBusString,DBusInt64> ofStringToInt64()

Creates a dictionary with string keys and int64 values.

Returns:

a new empty DBusDict with string keys and int64 values

ofStringToBoolean

public static DBusDict<DBusString,DBusBoolean> ofStringToBoolean()

Creates a dictionary with string keys and boolean values.

Returns:

a new empty DBusDict with string keys and boolean values

ofInt32ToString

public static DBusDict<DBusInt32,DBusString> ofInt32ToString()

Creates a dictionary with int32 keys and string values.

Returns:

a new empty DBusDict with int32 keys and string values

ofObjectPathToString

public static DBusDict<DBusObjectPath,DBusString> ofObjectPathToString()

Creates a dictionary with object path keys and string values.

Returns:

a new empty DBusDict with object path keys and string values

fromStringMap

public static DBusDict<DBusString,DBusString> fromStringMap(Map<String,String> map)

Creates a dictionary with string keys and string values from a Java Map.

Parameters:

map - the Java map to convert

Returns:

a new DBusDict containing the map entries

fromVariantMap

public static DBusDict<DBusString,DBusVariant> fromVariantMap(Map<String,Object> map)

Creates a dictionary with string keys and variant values from a Java Map.

Parameters:

map - the Java map to convert

Returns:

a new DBusDict containing the map entries as variants

getSignature

public DBusSignature getSignature()

Description copied from interface: DBusContainerType

Gets the signature of this container type. The returned signature describes the container and its content.

Specified by:

getSignature in interface DBusContainerType

Returns:

a DBusSignature

getType

public Type getType()

Description copied from interface: DBusType

Gets the type of this implementation.

Specified by:

getType in interface DBusType

Returns:

a Type

getDelegate

public Map<KeyT,ValueT> getDelegate()

Description copied from interface: DBusContainerType

Gets the wrapped value of this container type. The D-Bus type system is made of ASCII characters representing the value's type. Each D-Bus data type is mapped in this framework by its corresponding class. This method enables the access to the Java's data type - the delegate. If this container is for example a DBusArray, the returned object will be a List.

Specified by:

getDelegate in interface DBusContainerType

Returns:

an Object

size

public int size()

Specified by:

size in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

get

public ValueT get(Object key)

Specified by:

get in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

put

public ValueT put(KeyT key,
 ValueT value)

Specified by:

put in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

remove

public ValueT remove(Object key)

Specified by:

remove in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

putAll

public void putAll(Map<? extends KeyT,? extends ValueT> m)

Specified by:

putAll in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

clear

public void clear()

Specified by:

clear in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

keySet

public Set<KeyT> keySet()

Specified by:

keySet in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

values

public Collection<ValueT> values()

Specified by:

values in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

entrySet

public Set<Map.Entry<KeyT,ValueT>> entrySet()

Specified by:

entrySet in interface Map<KeyT extends DBusBasicType,ValueT extends DBusType>

dictionaryEntrySet

public Set<DBusDictEntry<KeyT,ValueT>> dictionaryEntrySet()

Returns a set view of the mappings contained in this map.

Returns:

a set

toString

public String toString()

Overrides:

toString in class Object