Top Description Fields Constructors Methods
com.sun.star.lib.uno.environments.remote

public Class Message

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.star.lib.uno.protocols.urp.UrpMessage
Imports
com.sun.star.lib.uno.typedesc.MethodDescription, .TypeDescription, com.sun.star.uno.XCurrentContext

A remote request or reply message.

Field Summary

Modifier and TypeField and Description
private final boolean
private final Object[]
private final com.sun.star.uno.XCurrentContext
private final MethodDescription
private final String
private final boolean
private final Object
private final boolean
private final ThreadId
private final TypeDescription

Constructor Summary

AccessConstructor and Description
public
Message(ThreadId threadId, boolean request, String objectId, TypeDescription type, MethodDescription method, boolean synchronous, com.sun.star.uno.XCurrentContext currentContext, boolean abnormalTermination, Object result, Object[] arguments)

Method Summary

Modifier and TypeMethod and Description
public final Object[]

Returns:

the in and in– { }out arguments for a request (possibly null for a parameterless function), the out and in– { }out arguments for a reply that represents normal termination (possibly null for a parameterless function), null for a reply that represents abnormal termination.
getArguments
()

Returns the arguments of a message.

public com.sun.star.uno.XCurrentContext

Returns:

the current context (which may be null) for a request, null for a reply.
getCurrentContext
()

Returns the current context of a request message.

public final MethodDescription

Returns:

the (non-null) method description for a request, null for a reply.
getMethod
()

Returns the method description of a request message.

public final String

Returns:

the (non-null) object ID for a request, null for a reply.
getObjectId
()

Returns the object ID of a request message.

public final Object

Returns:

any (possibly null) return value for a reply that represents normal termination, the (non-null) exception for a reply that represents abnormal termination, null for a request.
getResult
()

Returns the result of a reply message.

public final ThreadId

Returns:

the (non-null) thread ID.
getThreadId
()

Returns the thread ID of the message.

public final TypeDescription

Returns:

the (non-null) type for a request, null for a reply.
getType
()

Returns the type of a request message.

public final boolean

Returns:

true for a reply that represents abnormal termination, false for a reply that represents normal termination or a request.
isAbnormalTermination
()

Returns whether the reply message represents abnormal termination.

public final boolean

Returns:

true for a request, false for a reply.
isRequest
()

Returns whether the message is a request or a reply.

public final boolean

Returns:

true for a synchronous request, false for an asynchronous request or a reply.
isSynchronous
()

Returns whether the request message is synchronous.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

abnormalTerminationback to summary
private final boolean abnormalTermination
argumentsback to summary
private final Object[] arguments
currentContextback to summary
private final com.sun.star.uno.XCurrentContext currentContext
methodback to summary
private final MethodDescription method
objectIdback to summary
private final String objectId
requestback to summary
private final boolean request
resultback to summary
private final Object result
synchronousback to summary
private final boolean synchronous
threadIdback to summary
private final ThreadId threadId
typeback to summary
private final TypeDescription type

Constructor Detail

Messageback to summary
public Message(ThreadId threadId, boolean request, String objectId, TypeDescription type, MethodDescription method, boolean synchronous, com.sun.star.uno.XCurrentContext currentContext, boolean abnormalTermination, Object result, Object[] arguments)

Method Detail

getArgumentsback to summary
public final Object[] getArguments()

Returns the arguments of a message.

Valid only for request messages and reply messages that represent normal termination. Any returned array must not be modified.

Returns:Object[]

the in and in– { }out arguments for a request (possibly null for a parameterless function), the out and in– { }out arguments for a reply that represents normal termination (possibly null for a parameterless function), null for a reply that represents abnormal termination.

getCurrentContextback to summary
public com.sun.star.uno.XCurrentContext getCurrentContext()

Returns the current context of a request message.

Valid only for request messages.

Returns:com.sun.star.uno.XCurrentContext

the current context (which may be null) for a request, null for a reply.

getMethodback to summary
public final MethodDescription getMethod()

Returns the method description of a request message.

Valid only for request messages. The returned MethodDescription is consistent with the type of the message.

Returns:MethodDescription

the (non-null) method description for a request, null for a reply.

getObjectIdback to summary
public final String getObjectId()

Returns the object ID of a request message.

Valid only for request messages.

Returns:String

the (non-null) object ID for a request, null for a reply.

getResultback to summary
public final Object getResult()

Returns the result of a reply message.

Valid only for reply messages.

Returns:Object

any (possibly null) return value for a reply that represents normal termination, the (non-null) exception for a reply that represents abnormal termination, null for a request.

getThreadIdback to summary
public final ThreadId getThreadId()

Returns the thread ID of the message.

Valid for all kinds of messages.

Returns:ThreadId

the (non-null) thread ID.

getTypeback to summary
public final TypeDescription getType()

Returns the type of a request message.

Valid only for request messages.

Returns:TypeDescription

the (non-null) type for a request, null for a reply.

isAbnormalTerminationback to summary
public final boolean isAbnormalTermination()

Returns whether the reply message represents abnormal termination.

Valid only for reply messages.

Returns:boolean

true for a reply that represents abnormal termination, false for a reply that represents normal termination or a request.

isRequestback to summary
public final boolean isRequest()

Returns whether the message is a request or a reply.

Valid for all kinds of messages.

Returns:boolean

true for a request, false for a reply.

isSynchronousback to summary
public final boolean isSynchronous()

Returns whether the request message is synchronous.

Valid only for request messages.

Returns:boolean

true for a synchronous request, false for an asynchronous request or a reply.