Top Description Fields Constructors Methods
org.freedesktop.dbus

public final Class FileDescriptor

extends Object
Class Inheritance
Imports
org.freedesktop.dbus.exceptions.MarshallingException, org.freedesktop.dbus.spi.message.ISocketProvider, org.freedesktop.dbus.utils.ReflectionFileDescriptorHelper, java.util.Optional

Represents a FileDescriptor to be passed over the bus.
Can be created from either an integer (gotten through some JNI/JNA/JNR call) or from a java.io.FileDescriptor.

Field Summary

Modifier and TypeField and Description
private final int

Constructor Summary

AccessConstructor and Description
public
FileDescriptor(int _fd)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
_o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public static FileDescriptor

Returns:

DBus FileDescriptor
fromJavaFileDescriptor
(FileDescriptor
file descriptor
_data
,
ISocketProvider
socket provider or null
_provider
)

Utility method to create a DBus FileDescriptor from a java.io.FileDescriptor.

public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public FileDescriptor

Returns:

java file descriptor
toJavaFileDescriptor
(ISocketProvider
provider or null
_provider
)

Converts this DBus FileDescriptor to a java.io.FileDescriptor.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

fdback to summary
private final int fd

Constructor Detail

FileDescriptorback to summary
public FileDescriptor(int _fd)

Method Detail

equalsback to summary
public boolean equals(Object _o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
_o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
fromJavaFileDescriptorback to summary
public static FileDescriptor fromJavaFileDescriptor(FileDescriptor _data, ISocketProvider _provider) throws MarshallingException

Utility method to create a DBus FileDescriptor from a java.io.FileDescriptor.
Tries to use the provided ISocketProvider if present first.
If not present or conversion failed, tries to convert using reflection.

Parameters
_data:FileDescriptor

file descriptor

_provider:ISocketProvider

socket provider or null

Returns:FileDescriptor

DBus FileDescriptor

Exceptions
MarshallingException:
when conversion fails
getIntFileDescriptorback to summary
public int getIntFileDescriptor()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toJavaFileDescriptorback to summary
public FileDescriptor toJavaFileDescriptor(ISocketProvider _provider) throws MarshallingException

Converts this DBus FileDescriptor to a java.io.FileDescriptor.
Tries to use the provided ISocketProvider if present first.
If not present or conversion failed, tries to convert using reflection.

Parameters
_provider:ISocketProvider

provider or null

Returns:FileDescriptor

java file descriptor

Exceptions
MarshallingException:
when converting fails
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override