com.mathworks.toolbox.javabuilder

Class MWComponentOptions

java.lang.Object

com.mathworks.toolbox.javabuilder.MWComponentOptions

public class MWComponentOptions
extends java.lang.Object

Options per component instance. When creating a new instance of a class generated by MATLAB Java Package, an instance of MWComponentOptions may be passed to override the default behavior of the created object. For example, a PrintStream may be specified to capture output from MATLAB code invoked using the object, or an alternate location for CTF data may be specified.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
MWComponentOptions() Create default option set for deployed component initialization.
MWComponentOptions(MWComponentOptions that) Create a clone of that.
MWComponentOptions(java.lang.Object... options) Create an option set with all of the specified component initialization options applied to it.

Method Summary

Modifier and Type	Method and Description
MWCtfSource	getCtfSource() From where should CTF data be read?
java.util.concurrent.Callable<java.io.PrintStream>	getErrorStream() The Callable<PrintStream> which, when called, produces the PrintStream object to which error output from MATLAB code should be written.
com.mathworks.toolbox.javabuilder.internal.MWMCR	getExecutionContext() The MATLAB Runtime instance to be used for execution of MATLAB code by components initialized using this.
MWCtfExtractLocation	getExtractLocation() To where should extracted CTF data be written?
java.util.concurrent.Callable<java.io.PrintStream>	getPrintStream() The Callable<PrintStream> which, when called, produces the PrintStream object to which standard output from MATLAB code should be written.
void	setCtfSource(MWCtfSource ctfSource) Set the source for reading CTF data.
void	setErrorStream(java.util.concurrent.Callable<java.io.PrintStream> err) Set the destination for error output written by MATLAB code in the scope of all component instances initialized using this.
void	setErrorStream(java.io.PrintStream err) Set the destination for error output written by MATLAB code in the scope of all component instances initialized using this.
void	setExecutionContext(com.mathworks.toolbox.javabuilder.internal.MWMCR executionContext) Set the MATLAB Runtime instance to be used for execution of MATLAB code by components initialized using this.
void	setExtractLocation(MWCtfExtractLocation extractLocation) Set where CTF data should be written.
void	setPrintStream(java.util.concurrent.Callable<java.io.PrintStream> out) Set the destination for standard output written by MATLAB code in the scope of all component instances initialized using this.
void	setPrintStream(java.io.PrintStream out) Set the destination for standard output written by MATLAB code in the scope of all component instances initialized using this.

Methods inherited from class java.lang.Object

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

Constructor Detail

MWComponentOptions

public MWComponentOptions()

Create default option set for deployed component initialization.

MWComponentOptions

public MWComponentOptions(java.lang.Object... options)

Create an option set with all of the specified component initialization options applied to it. Each object in options must be either a PrintStream (in which case the first such object is set to receive standard output, and the second such object, if present, is set to receive error output) or an implementation of MWComponentOption. The effect of applying objects that implement MWComponentOption is documented per implementation class. The passed list of options is applied, in order, to this.

Parameters:

options - comma-separated list of zero or more options

Throws:

java.lang.IllegalArgumentException - if any of the options is neither an MWComponentOption nor a PrintStream

See Also:

MWComponentOption, MWCtfSource, MWCtfExtractLocation, MWMCR

MWComponentOptions

public MWComponentOptions(MWComponentOptions that)

Create a clone of that.

Parameters:

that - options to be cloned

Method Detail

getCtfSource

public MWCtfSource getCtfSource()

From where should CTF data be read?

Returns:

the CTF data source specified by this option set

getExtractLocation

public MWCtfExtractLocation getExtractLocation()

To where should extracted CTF data be written?

Returns:

the location for extracted CTF data specified by this option set.

setExtractLocation

public void setExtractLocation(MWCtfExtractLocation extractLocation)

Set where CTF data should be written.

Parameters:

extractLocation - location to which CTF data should be written

See Also:

MWCtfExtractLocation

setCtfSource

public void setCtfSource(MWCtfSource ctfSource)

Set the source for reading CTF data.

Parameters:

ctfSource - source for reading CTF data

See Also:

MWCtfSource

getExecutionContext

public com.mathworks.toolbox.javabuilder.internal.MWMCR getExecutionContext()

The MATLAB Runtime instance to be used for execution of MATLAB code by components initialized using this. Internal use only

Returns:

the MWMCR if specified otherwise null

setExecutionContext

public void setExecutionContext(com.mathworks.toolbox.javabuilder.internal.MWMCR executionContext)

Set the MATLAB Runtime instance to be used for execution of MATLAB code by components initialized using this. Internal use only

Parameters:

executionContext - MATLAB Runtime instance to be used by components

getPrintStream

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

The Callable<PrintStream> which, when called, produces the PrintStream object to which standard output from MATLAB code should be written.

Returns:

printStream to which standard output from MATLAB code should be written

setPrintStream

public void setPrintStream(java.io.PrintStream out)

Set the destination for standard output written by MATLAB code in the scope of all component instances initialized using this.

Parameters:

out - destination for standard output

setPrintStream

public void setPrintStream(java.util.concurrent.Callable<java.io.PrintStream> out)

Set the destination for standard output written by MATLAB code in the scope of all component instances initialized using this. Every time standard output is requested from MATLAB code, the Callable<PrintStream> associated with the component instance will be invoked to retrieve the PrintStream to use. This allows the PrintStream used by a component instance to change over time, if desired.

Parameters:

out - returns the destination for MATLAB standard output

getErrorStream

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

The Callable<PrintStream> which, when called, produces the PrintStream object to which error output from MATLAB code should be written.

Returns:

object to which error output from MATLAB code should be written

setErrorStream

public void setErrorStream(java.io.PrintStream err)

Set the destination for error output written by MATLAB code in the scope of all component instances initialized using this.

Parameters:

err - the destination for MATLAB error output

setErrorStream

public void setErrorStream(java.util.concurrent.Callable<java.io.PrintStream> err)

Set the destination for error output written by MATLAB code in the scope of all component instances initialized using this. Every time error output is requested from MATLAB code, the Callable<PrintStream> associated with the component instance will be invoked to retrieve the PrintStream to use. This allows the PrintStream used by a component instance to change over time, if desired.

Parameters:

err - returns the destination for MATLAB error output