org.omg.CORBA

Class CompletionStatusHelper

public abstract class CompletionStatusHelper extends Object

Provides static helper methods for working with {@link CompletionStatus}.

Method Summary
static CompletionStatus	extract(Any a) Extract the {@link CompletionStatus} from the given {@link Any}.
static String	id() Returns the agreed Id.
static void	insert(Any into, CompletionStatus that) Insert into the given {@link CompletionStatus} into the given {@link Any}.
static CompletionStatus	read(InputStream input) Reads the {@link CompletionStatus} from the CORBA input stream.
static TypeCode	type() Get the parameter mode typecode (enumeration, named "CompletionStatus").
static void	write(OutputStream output, CompletionStatus status) Writes the {@link CompletionStatus} into the given stream.

Method Detail

extract

public static CompletionStatus extract(Any a)

Extract the {@link CompletionStatus} from the given {@link Any}. This implementation expects the integer (Corba long) value, stating the completion status.

Parameters: a an Any to extract the completion status from.

Returns: completion status

id

public static String id()

Returns the agreed Id.

Returns: IDL:omg.org/CORBA/CompletionStatus:1.0, always.

insert

public static void insert(Any into, CompletionStatus that)

Insert into the given {@link CompletionStatus} into the given {@link Any}. This implementation inserts it as an integer (CORBA long).

Parameters: into the target Any. that the {@link CompletionStatus} to insert.

read

public static CompletionStatus read(InputStream input)

Reads the {@link CompletionStatus} from the CORBA input stream. This implementation reads an an integer (CORBA long).

Parameters: input the CORBA (not java.io) stream to read from.

Returns: the value from the stream.

Get the parameter mode typecode (enumeration, named "CompletionStatus"). The typecode states that the enumeration can obtain one of the following values: COMPLETED_YES ,COMPLETED_NO or COMPLETED_MAYBE .

write

public static void write(OutputStream output, CompletionStatus status)

Writes the {@link CompletionStatus} into the given stream. This implementation writes an int (CORBA long), corresponding the status of completion.

Parameters: output the CORBA (not java.io) output stream to write. status the value that must be written.