Package com.lucimber.dbus.type

Enum Class Type

java.lang.Object
java.lang.Enum<Type>
com.lucimber.dbus.type.Type
All Implemented Interfaces:
Serializable, Comparable<Type>, Constable
public enum Type extends Enum<Type>
Represents the data types defined by D-Bus. For further information consult the official documentation.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ARRAY
    An array is a container type and can store a sequence of a single complete type.
    BOOLEAN
    Boolean value, 0 is FALSE and 1 is TRUE.
    BYTE
    Unsigned 8-bit integer.
    DICT_ENTRY
    An entry is a container type and can store a key-value pair consisting of two single complete types.
    DOUBLE
    IEEE 754 double-precision floating point.
    INT16
    Signed (two's complement) 16-bit integer.
    INT32
    Signed (two's complement) 32-bit integer Equivalent to Java's integer data type.
    INT64
    Signed (two's complement) 64-bit integer Equivalent to Java's long data type.
    OBJECT_PATH
    An object path is a string-like type and represents a name used to refer to an object instance.
    SIGNATURE
    A signature is a string-like type and forms a list of single complete types.
    STRING
    UTF-8 string (must be valid UTF-8).
    STRUCT
    A struct is a container type and can store one or many single complete types.
    UINT16
    Unsigned 16-bit integer.
    UINT32
    Unsigned 32-bit integer.
    UINT64
    Unsigned 64-bit integer.
    UNIX_FD
    Unsigned 32-bit integer representing an index into an out-of-band array of file descriptors, transferred via some platform-specific mechanism.
    VARIANT
    A variant is a container type and can store one single complete type.

  • Method Summary

    Modifier and Type
    Method
    Description
    TypeAlignment
    getAlignment()
    Gets the type's related alignment.
    TypeCode
    getCode()
    Gets the type's related code.
    static Type
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Type[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BYTE

      public static final Type BYTE
      Unsigned 8-bit integer. ASCII type-code is 121 (ASCII 'y').

    • BOOLEAN

      public static final Type BOOLEAN
      Boolean value, 0 is FALSE and 1 is TRUE. Everything else is invalid. ASCII type-code is 98 (ASCII 'b').

    • INT16

      public static final Type INT16
      Signed (two's complement) 16-bit integer. Equivalent to Java's short data type. ASCII type-code is 110 (ASCII 'n').

    • UINT16

      public static final Type UINT16
      Unsigned 16-bit integer. ASCII type-code is 113 (ASCII 'q').

    • INT32

      public static final Type INT32
      Signed (two's complement) 32-bit integer Equivalent to Java's integer data type. ASCII type-code is 105 (ASCII 'i').

    • UINT32

      public static final Type UINT32
      Unsigned 32-bit integer. ASCII type-code is 117 (ASCII 'u').

    • INT64

      public static final Type INT64
      Signed (two's complement) 64-bit integer Equivalent to Java's long data type. ASCII type-code is 120 (ASCII 'x').

    • UINT64

      public static final Type UINT64
      Unsigned 64-bit integer. ASCII type-code is 116 (ASCII 't').

    • DOUBLE

      public static final Type DOUBLE
      IEEE 754 double-precision floating point. Equivalent to Java's double data type. ASCII type-code is 100 (ASCII 'd').

    • STRING

      public static final Type STRING
      UTF-8 string (must be valid UTF-8). Must be nul terminated and contain no other nul bytes. ASCII type-code is 115 (ASCII 's').

    • OBJECT_PATH

      public static final Type OBJECT_PATH
      An object path is a string-like type and represents a name used to refer to an object instance. ASCII type-code is 111 (ASCII 'o').

    • SIGNATURE

      public static final Type SIGNATURE
      A signature is a string-like type and forms a list of single complete types. ASCII type-code is 103 (ASCII 'g').

    • ARRAY

      public static final Type ARRAY
      An array is a container type and can store a sequence of a single complete type. ASCII type-code is 97 (ASCII 'a').

    • STRUCT

      public static final Type STRUCT
      A struct is a container type and can store one or many single complete types. ASCII type-codes are 40 (ASCII '(') and 41 (ASCII ')').

    • VARIANT

      public static final Type VARIANT
      A variant is a container type and can store one single complete type. Variant type (the type of the value is part of the value itself). ASCII type-code is 118 (ASCII 'v').

    • DICT_ENTRY

      public static final Type DICT_ENTRY
      An entry is a container type and can store a key-value pair consisting of two single complete types. Entries are used in a dict or map (array of key-value pairs). ASCII type-codes are 123 (ASCII '{') and 125 (ASCII '}').

    • UNIX_FD

      public static final Type UNIX_FD
      Unsigned 32-bit integer representing an index into an out-of-band array of file descriptors, transferred via some platform-specific mechanism. ASCII type-code is 104 (ASCII 'h').

  • Method Details

    • values

      public static Type[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Type valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getAlignment

      public TypeAlignment getAlignment()
      Gets the type's related alignment.
      Returns:
      The TypeAlignment.

    • getCode

      public TypeCode getCode()
      Gets the type's related code.
      Returns:
      a TypeCode