Package com.lucimber.dbus.message

Enum Class HeaderField

java.lang.Object

java.lang.Enum<HeaderField>

com.lucimber.dbus.message.HeaderField

All Implemented Interfaces:

Serializable, Comparable<HeaderField>, Constable

public enum HeaderField
extends Enum<HeaderField>

D-Bus header field codes, as defined by the D-Bus specification.

Each header field is represented as a single byte code and maps to a standard D-Bus header entry in the a{yv} dict.

Since:

1.0

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
DESTINATION	Destination bus name.
ERROR_NAME	Error name for error messages.
INTERFACE	Interface name associated with the message.
MEMBER	Member (method or signal) name.
PATH	Object path to the object receiving or emitting the message.
REPLY_SERIAL	Reply serial for method return messages.
SENDER	Sender bus name.
SIGNATURE	Signature of the body parameters.
UNIX_FDS	Number of UNIX file descriptors in the message.

Method Summary

Modifier and Type	Method	Description
static HeaderField	fromCode(byte code)	Looks up a HeaderField by its byte code.
byte	getCode()	Returns the byte code for this header field.
static HeaderField	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HeaderField[]	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

PATH

public static final HeaderField PATH

Object path to the object receiving or emitting the message.

INTERFACE

public static final HeaderField INTERFACE

Interface name associated with the message.

MEMBER

public static final HeaderField MEMBER

Member (method or signal) name.

ERROR_NAME

public static final HeaderField ERROR_NAME

Error name for error messages.

REPLY_SERIAL

public static final HeaderField REPLY_SERIAL

Reply serial for method return messages.

DESTINATION

public static final HeaderField DESTINATION

Destination bus name.

SENDER

public static final HeaderField SENDER

Sender bus name.

SIGNATURE

public static final HeaderField SIGNATURE

Signature of the body parameters.

UNIX_FDS

public static final HeaderField UNIX_FDS

Number of UNIX file descriptors in the message.

Method Details

values

public static HeaderField[] 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 HeaderField 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

fromCode

public static HeaderField fromCode(byte code)

Looks up a HeaderField by its byte code.

Parameters:

code - the byte code

Returns:

the matching HeaderField

Throws:

IllegalArgumentException - if no matching field exists

getCode

public byte getCode()

Returns the byte code for this header field.

Returns:

the D-Bus header field code