org.freedesktop.dbus

Class Variant<T>

java.lang.Object

org.freedesktop.dbus.Variant<T>

public class Variant<T>
extends Object

A Wrapper class for Variant values. A method on DBus can send or receive a Variant. This will wrap another value whose type is determined at runtime. The Variant may be parameterized to restrict the types it may accept.

Constructor Summary

Constructors

Constructor and Description
Variant(T value) Create a Variant from a basic type object.
Variant(T value, String type) Create a Variant.
Variant(T value, Type type) Create a Variant.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Compare this Variant with another by comparing contents.
String	getSig() Return the dbus signature of the wrapped value.
Type	getType() Return the type of the wrapped value.
T	getValue() Return the wrapped value.
String	toString() Format the Variant as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Variant

public Variant(T value)
        throws IllegalArgumentException

Create a Variant from a basic type object.

Parameters:

value - The wrapped value.

Throws:

IllegalArgumentException - If you try and wrap Null or an object of a non-basic type.

Variant

public Variant(T value,
               Type type)
        throws IllegalArgumentException

Create a Variant.

Parameters:

value - The wrapped value.

type - The explicit type of the value.

Throws:

IllegalArgumentException - If you try and wrap Null or an object which cannot be sent over DBus.

Variant

public Variant(T value,
               String type)
        throws IllegalArgumentException

Create a Variant.

Parameters:

value - The wrapped value.

type - The explicit type of the value, as a DBus type string.

Throws:

IllegalArgumentException - If you try and wrap Null or an object which cannot be sent over DBus.

Method Detail

getValue

public T getValue()

Return the wrapped value.

Returns:

value

getType

public Type getType()

Return the type of the wrapped value.

Returns:

type

getSig

public String getSig()

Return the dbus signature of the wrapped value.

Returns:

signature

toString

public String toString()

Format the Variant as a string.

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Compare this Variant with another by comparing contents.

Overrides:

equals in class Object

Parameters:

other - other object

Returns:

boolean