com.mathworks.toolbox.javabuilder

Class MWApplication

java.lang.Object

com.mathworks.toolbox.javabuilder.MWApplication

public class MWApplication
extends java.lang.Object

The MWApplication class can be used to initialize the global state of MATLAB Runtime. This class also provides methods to access this global state.

Constructor Summary

Constructors

Constructor and Description
MWApplication()

Method Summary

Modifier and Type	Method and Description
static java.util.concurrent.Callable<java.io.PrintStream>	getDefaultErrorStream() The current late-bound PrintStream for MATLAB Runtime error text.
static java.util.concurrent.Callable<java.io.PrintStream>	getDefaultOutputStream() The current late-bound PrintStream for MATLAB Runtime output text.
static java.lang.String	getMCRLogfileName() Function to get the logfile name used by MATLAB Runtime
static void	initialize(MWMCROption... options) Initializes the global state of MATLAB Runtime
static void	initializeApplication(MWMCROption... options) Deprecated. use initialize instead.
static boolean	isMCRInitialized() Function to query whether MATLAB Runtime has been initialized
static boolean	isMCRJVMEnabled() Function to check whether MATLAB Runtime has been initialized with JVM
static boolean	isMCRNoDisplaySet() Function to check whether MATLAB Runtime has been initialized with display set
static void	terminate() Terminates usage of the MATLAB Runtime.

Methods inherited from class java.lang.Object

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

Constructor Detail

MWApplication

public MWApplication()

Method Detail

initializeApplication

@Deprecated
public static void initializeApplication(MWMCROption... options)

Deprecated. use initialize instead.

Initializes the global state of MATLAB Runtime

Parameters:

options - Array of MWMCROption representing MATLAB Runtime options

initialize

public static void initialize(MWMCROption... options)

Initializes the global state of MATLAB Runtime

Parameters:

options - Array of MWMCROption representing MATLAB Runtime options

isMCRInitialized

public static boolean isMCRInitialized()

Function to query whether MATLAB Runtime has been initialized

Returns:

Returns true if MATLAB Runtime has been initialized, else returns false

isMCRJVMEnabled

public static boolean isMCRJVMEnabled()

Function to check whether MATLAB Runtime has been initialized with JVM

Returns:

Returns true if MATLAB Runtime has been initialized with JVM, else returns false

isMCRNoDisplaySet

public static boolean isMCRNoDisplaySet()

Function to check whether MATLAB Runtime has been initialized with display set

Returns:

Returns true if display is not set, else returns false.

NOTE: This function always returns false on Windows since the -nodisplay option is not supported on Windows.

getMCRLogfileName

public static java.lang.String getMCRLogfileName()

Function to get the logfile name used by MATLAB Runtime

Returns:

Returns the string representing the name of the logfile

terminate

public static void terminate()

Terminates usage of the MATLAB Runtime. This method should be called when the Java application is shutting down or no longer needs the services of the MATLAB Runtime. Normally the user does not need to call this method because it is automatically called by a JVM shutdown hook installed when the MATLAB Runtime has been initialized. If shutdown hooks are not expected to run, it is crucial that this method be called before the application exits. Failure to do so will result in undefined behavior.

getDefaultOutputStream

public static java.util.concurrent.Callable<java.io.PrintStream> getDefaultOutputStream()

The current late-bound PrintStream for MATLAB Runtime output text.

Returns:

default output stream

getDefaultErrorStream

public static java.util.concurrent.Callable<java.io.PrintStream> getDefaultErrorStream()

The current late-bound PrintStream for MATLAB Runtime error text.

Returns:

default error stream