Package org.freedesktop.dbus.types

Class Variant<T>

  • public class Variant<T>
extends java.lang.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.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.slf4j.Logger logger  
      private java.lang.String sig  
      private java.lang.reflect.Type type  
      private T value  

    • Constructor Summary

      Constructors 
      Constructor Description
      Variant​(T _value)
      Create a Variant from a basic type object.
      Variant​(T _value, java.lang.reflect.Type _type)
      Create a Variant.
      Variant​(T _value, java.lang.String _sig)
      Create a Variant.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object _obj)
      Compare this Variant with another by comparing contents.
      java.lang.String getSig()
      Return the dbus signature of the wrapped value.
      java.lang.reflect.Type getType()
      Return the type of the wrapped value.
      T getValue()
      Return the wrapped value.
      int hashCode()  
      java.lang.String toString()
      Format the Variant as a string.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • logger

        private final org.slf4j.Logger logger

      • value

        private final T value

      • type

        private final java.lang.reflect.Type type

      • sig

        private final java.lang.String sig

    • Constructor Detail

      • Variant

        public Variant​(T _value)
        throws java.lang.IllegalArgumentException
        Create a Variant from a basic type object.
        Parameters:
        _value - The wrapped value.
        Throws:
        java.lang.IllegalArgumentException - If you try and wrap Null or an object of a non-basic type.

      • Variant

        public Variant​(T _value,
               java.lang.reflect.Type _type)
        throws java.lang.IllegalArgumentException
        Create a Variant.
        Parameters:
        _value - The wrapped value.
        _type - The explicit type of the value.
        Throws:
        java.lang.IllegalArgumentException - If you try and wrap Null or an object which cannot be sent over DBus.

      • Variant

        public Variant​(T _value,
               java.lang.String _sig)
        throws java.lang.IllegalArgumentException
        Create a Variant.
        Parameters:
        _value - The wrapped value.
        _sig - The explicit type of the value, as a dbus type string.
        Throws:
        java.lang.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 java.lang.reflect.Type getType()
        Return the type of the wrapped value.
        Returns:
        type

      • getSig

        public java.lang.String getSig()
        Return the dbus signature of the wrapped value.
        Returns:
        signature

      • toString

        public java.lang.String toString()
        Format the Variant as a string.
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

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