org.eclipse.milo.opcua.sdk.server.api.methods

Class Out<T>

java.lang.Object

org.eclipse.milo.opcua.sdk.server.api.methods.Out<T>

Type Parameters:

T - the value type.

public class Out<T>
extends Object

An "Out" param for an OPC UA method.

OPC UA Methods use Out parameters to return zero, one, or multiple values instead of traditional function return values.

Constructor Summary

Constructors

Constructor and Description
Out()

Method Summary

Modifier and Type	Method and Description
T	get() Get the value for this Out param.
T	getRaw() Get the value for this Out param.
boolean	isSet() Return true if the value has been set, i.e.
void	set(T value) Set the value for this Out param.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Out

public Out()

Method Detail

get

@Nullable
public T get()
                throws UaException

Get the value for this Out param.

Returns:

the value for this Out param.

Throws:

UaException - if the value has not been set.

getRaw

@Nullable
public T getRaw()

Get the value for this Out param.

Returns:

the value for this Out param.

set

public void set(@Nullable
                T value)

Set the value for this Out param.

Parameters:

value - the value.

isSet

public boolean isSet()

Return true if the value has been set, i.e. set(Object) has been called.

This allows the distinction between a value that hasn't been set versus a value that was set to null.

Returns:

true if the value has been set.