com.mathworks.toolbox.javabuilder.MWComponentOptions Class

Namespace: com.mathworks.toolbox.javabuilder

Java class to manage component instance options in MATLAB

Description

Declaration

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

Creation

Constructors

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.

Properties

No fields.

Methods

expand all

Public Methods

`getCtfSource`	`public MWCtfSource getCtfSource()` From where should CTF data be read? Returns: The CTF data source specified by this option set.
`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.
`getExecutionContext`	`public com.mathworks.toolbox.javabuilder.internal.MWMCR getExecutionContext()`
`getExtractLocation`	`public MWCtfExtractLocation getExtractLocation()` To where should extracted CTF data be written? Returns: The location for extracted CTF data specified by this option set.
`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
`setCtfSource`	`public void setCtfSource(MWCtfSource ctfSource)` Set the source for reading CTF data. Parameters: ctfSource Source for reading CTF data.
`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 The destination for MATLAB error output.
`setExecutionContext`	`public void setExecutionContext(com.mathworks.toolbox.javabuilder.internal.MWMCR executionContext)`
`setExtractLocation`	`public void setExtractLocation(MWCtfExtractLocation extractLocation)` Set where CTF data should be written. Parameters: extractLocation Location to which CTF data 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.

Inherited Methods

Methods inherited from class java.lang.Object.

`clone`	`clone()` Used to create and return a copy of the object it is called on. This method is protected and provides a shallow copy, meaning it copies the values of an object's fields directly. For fields that are objects, it copies references, not the objects themselves.
`finalize`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`getClass`	`public final Class<?> getClass()` Returns the runtime class of this Object.
`hashCode`	`hashCode()` Used to return a hash code value for the object. This integer value is used for efficiently storing objects in hash-based collections like `HashMap`, `HashSet`, and `HashTable`. The general contract of `hashCode()` is that if two objects are equal according to the `equals()` method, they must return the same hash code. It's important to override `hashCode()` in a manner consistent with `equals()` to maintain this contract.
`notify`	`public final void notify()`
`notifyAll`	`public final void notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`toString`	`toString()` Returns a string representation of the object, typically including its class name and hashcode, and can be overridden for customized representations.
`wait`	`public final void wait(long timeout, int nanos) throws InterruptedException` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

Version History

Introduced in R2006a