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 MCR. This class also provides methods to access this global state.

Constructor Summary

Constructors

Constructor and Description
MWApplication()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.concurrent.Callable<java.io.PrintStream>	getDefaultErrorStream() The current late-bound PrintStream for MCR error text.
static java.util.concurrent.Callable<java.io.PrintStream>	getDefaultOutputStream() The current late-bound PrintStream for MCR output text.
static java.lang.String	getMCRLogfileName() Function to get the logfile name used by MCR
static void	initialize(MWMCROption... options) Initializes the global state of MCR
static void	initializeApplication(MWMCROption... options) Deprecated. use initialize instead.
static boolean	isMCRInitialized() Function to query if MCR has been initialized
static boolean	isMCRJVMEnabled() Function to check if MCR is initialized with JVM
static boolean	isMCRNoDisplaySet() Function to check if MCR is initialized with display set *
static void	setDefaultPrintStream(java.io.PrintStream out) Sets the default PrintStream, where the MCR will write output that otherwise would have been written to System.out or System.err.
static void	setDefaultPrintStreams(java.util.concurrent.Callable<java.io.PrintStream> out, java.util.concurrent.Callable<java.io.PrintStream> err) Sets the default PrintStreams, where the MCR will write output that otherwise would have been written to System.out or System.err.
static void	setDefaultPrintStreams(java.io.PrintStream out, java.io.PrintStream err) Sets the default PrintStreams, where the MCR will write output that otherwise would have been written to System.out or System.err.
static void	terminate() Terminates usage of the MCR.

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 MCR

Parameters:

options - Array of MWMCROption representing MCR options

initialize

public static void initialize(MWMCROption... options)

Initializes the global state of MCR

Parameters:

options - Array of MWMCROption representing MCR options

isMCRInitialized

public static boolean isMCRInitialized()

Function to query if MCR has been initialized

Returns:

Returns true if MCR is initialized else returns false

isMCRJVMEnabled

public static boolean isMCRJVMEnabled()

Function to check if MCR is initialized with JVM

Returns:

Returns true if MCR is initialized with JVM else returns false

isMCRNoDisplaySet

public static boolean isMCRNoDisplaySet()

Function to check if MCR is initialized with display set *

Returns:

Returns true if display is set else returns false NOTE: This function always returns true on windows since -nodisplay option is not supported on Windows.

getMCRLogfileName

public static java.lang.String getMCRLogfileName()

Function to get the logfile name used by MCR

Returns:

Returns the string representing the name of the logfile

setDefaultPrintStream

public static void setDefaultPrintStream(java.io.PrintStream out)

Sets the default PrintStream, where the MCR will write output that otherwise would have been written to System.out or System.err.

setDefaultPrintStreams

public static void setDefaultPrintStreams(java.io.PrintStream out,
                          java.io.PrintStream err)

Sets the default PrintStreams, where the MCR will write output that otherwise would have been written to System.out or System.err.

setDefaultPrintStreams

public static void setDefaultPrintStreams(java.util.concurrent.Callable<java.io.PrintStream> out,
                          java.util.concurrent.Callable<java.io.PrintStream> err)

Sets the default PrintStreams, where the MCR will write output that otherwise would have been written to System.out or System.err. Specifying the PrintStreams via a Callable allows the actual PrintStream used to be late-bound at the time when text is written. For example: public class MyClass { public static PrintStream myOut; public static PrintStream myErr; } ... // Send output and error text to the current value of MyClass.myOut and MyClass.myErr whenever // text is written (as opposed to their value as of right now): MWApplication.setDefaultPrintStreams( new Callable() { public PrintStream call() { return MyClass.myOut; } }, new Callable() { public PrintStream call() { return MyClass.myErr; } } );

Parameters:

out - Callable the returns the PrintStream to which output not associated with any MCR instance is sent.

err - Callable the returns the PrintStream to which error text not associated with any MCR instance is sent.

terminate

public static void terminate()

Terminates usage of the MCR. This method should be called when the Java application is shutting down or no longer needs the services of the MCR. Normally the user does not need to call this method because it is automatically called by a JVM shutdown hook installed when the MCR is initialized. It is crucial, if shutdown hooks are not expected to run, 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 MCR output text.

getDefaultErrorStream

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

The current late-bound PrintStream for MCR error text.