com.mathworks.toolbox.javabuilder.MWCtfSource Class

Namespace: com.mathworks.toolbox.javabuilder

Java interface to interact with code archive (.ctf file) sources in MATLAB

Description

Declaration

public abstract class MWCtfSource 
extends java.lang.Object 
implements MWComponentOption

Abstract class that defines the interface for retrieving an InputStream for CTF source objects. InputStream can be obtained by calling the open method of the CTF source class. An IOException will be thrown if the CTF file or directory cannot be found.

Implemented Interfaces: MWComponentOption

Direct Known Subclasses: MWCtfClassLoaderSource, MWCtfDirectorySource, MWCtfFileSource, MWCtfStreamSource

Creation

Constructors

protected MWCtfSource()

The protected constructor MWCtfSource() is used to allow subclassing but prevents direct instantiation of the abstract MWCtfSource class.

Properties

Public Properties

No public properties.

Methods

Public Methods

apply	public void apply(MWComponentOptions options) Invoke options.setCtfSource( this ). Specified by: apply in interface MWComponentOption. Parameters: options The option set to which this option should be applied.
open	public java.io.InputStream open(java.lang.String componentName) throws java.io.IOException Throws: java.io.IOException Indicates to the caller that an attempt to open an InputStream for the CTF file may fail, for example, if the file does not exist, if the file is not readable, or if there's an error while creating the FileInputStream.

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.
equals	equals() Used to compare two objects for equality. It checks if the two objects are the same in terms of their content, rather than just comparing their references. By default, the equals() method compares the memory locations of objects (similar to the == operator). However, it is commonly overridden in subclasses to provide a more meaningful equality comparison based on the properties of the objects.
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.
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