xyz.cofe.win.activex

Class Apartment

java.lang.Object

xyz.cofe.win.activex.Apartment

public class Apartment
extends Object

Constructor Summary

Constructors

Constructor and Description
Apartment()

Method Summary

Modifier and Type	Method and Description
static Object	inApartment(Supplier closure) Call the closure in the context of the current apartment model, defaulting to MTA (the more universally applicable threading model)if no apartment model has been defined.
static void	initMTA() Initialize thread as an MTA (for compatibility with Java).
static void	initSTA() Initialize thread as an STA (for compatibility with Java).
static void	releaseMTA() Releases the MTA thread (for compatibility with Java).
static void	releaseSTA() Releases the STA thread (for compatibility with Java).
static Object	withMTA(Supplier closure) Call the closure in the context of an MTA.
static Object	withSTA(Supplier closure) Call the closure in the context of an STA.

Methods inherited from class java.lang.Object

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

Constructor Detail

Apartment

public Apartment()

Method Detail

inApartment

public static Object inApartment(Supplier closure)

Call the closure in the context of the current apartment model, defaulting to MTA (the more universally applicable threading model)if no apartment model has been defined.

This is the preferred way to wrap your code in an apartment context, since it works with either STA or MTA models. If you need to specifically use MTA or STA models, use the withMTA(java.util.function.Supplier) or withSTA(java.util.function.Supplier) methods. Note that MTA and STA methods do not nest and may not be used together in the same thread.

Parameters:

closure - The closure to call.

Returns:

The result of the closure.

See Also:

withMTA(java.util.function.Supplier), withSTA(java.util.function.Supplier)

withSTA

public static Object withSTA(Supplier closure)

Call the closure in the context of an STA. Supports nesting withSTA() calls, but not withMTA(java.util.function.Supplier). The use of withSTA() is discouraged, since it appears to cause JVM crashes in testing.

Parameters:

closure - The closure to call.

Returns:

The result of the closure.

See Also:

inApartment(java.util.function.Supplier)

initSTA

public static void initSTA()

Initialize thread as an STA (for compatibility with Java). Calling multiple times nests the call - call the release method matching multiple times. Cannot be used in conjunction with MTA thread.

releaseSTA

public static void releaseSTA()

Releases the STA thread (for compatibility with Java). Called in conjunction with initSTA().

withMTA

public static Object withMTA(Supplier closure)

Call the closure in the context of an MTA. Supports nesting withMTA() calls, but not withSTA(java.util.function.Supplier).

Parameters:

closure - The closure to call.

Returns:

The result of the closure.

See Also:

inApartment(java.util.function.Supplier)

initMTA

public static void initMTA()

Initialize thread as an MTA (for compatibility with Java). Calling multiple times nests the call - call the release method matching multiple times. Cannot be used in conjunction with STA thread.

releaseMTA

public static void releaseMTA()

Releases the MTA thread (for compatibility with Java). Called in conjunction with initMTA().