Module org.freedesktop.dbus
Package org.freedesktop.dbus.types

Class Variant<T>

java.lang.Object
org.freedesktop.dbus.types.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
    Description
    Variant(T _value)
    Create a Variant from a basic type object.
    Variant(T _value, Type _type)
    Create a Variant.
    Variant(T _value, String _sig)
    Create a Variant.
    It is expected that the given value is compatible with the provided DBus signature String.
    This constructor is intended to be used when a generic using class/interface should be wrapped.
    Map or List are two examples where it is not possible to determine the internal data type (the type represented by a generic placeholder) due to type erasure.
    Therefore the only way to properly serialize these Maps/Lists is by providing a suitable signature manually.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object _obj)
    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.
    int
    hashCode()
     
    String
    toString()
    Format the Variant as a string.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • 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 _sig) throws IllegalArgumentException
      Create a Variant.
      It is expected that the given value is compatible with the provided DBus signature String.
      This constructor is intended to be used when a generic using class/interface should be wrapped.
      Map or List are two examples where it is not possible to determine the internal data type (the type represented by a generic placeholder) due to type erasure.
      Therefore the only way to properly serialize these Maps/Lists is by providing a suitable signature manually.
      Parameters:
      _value - The wrapped value.
      _sig - 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 Details

    • 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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object _obj)
      Compare this Variant with another by comparing contents.
      Overrides:
      equals in class Object
      Parameters:
      _obj - other object
      Returns:
      boolean