com.mathworks.toolbox.javabuilder.MWCtfExtractLocation Class

Namespace: com.mathworks.toolbox.javabuilder

Java class to manage code archive (.ctf file) extraction locations in MATLAB

Description

Declaration

public class MWCtfExtractLocation extends java.lang.Object implements MWComponentOption, java.io.Serializable

This class is used to represent the location to which the CTF will be extracted. EXTRACT_TO_CACHE object means that CTF will be extracted to cache directory at runtime. EXTRACT_TO_COMPONENT_DIR object means that CTF will be extracted to the directory where the component resides

Implemented Interfaces: MWComponentOption, java.io.Serializable

Creation

Constructors

MWCtfExtractLocation(java.io.File dir)

Used to create an instance of MWCtfExtractLocation with a specific directory where the CTF file will be extracted. The provided File object represents the directory's filesystem path. The constructor sets the directory field of the newly created instance to the File object passed as the parameter, indicating the extraction target directory.

MWCtfExtractLocation(java.lang.String dir)

Used to create an instance of MWCtfExtractLocation with a directory specified by a string representing the path. The constructor creates a new File object using the provided string path and assigns it to the directory field of the new instance. This allows users to specify the extraction directory as a string path rather than a File object.

Properties

expand all

Public Properties

`EXTRACT_TO_CACHE` — Extract to a cache directory
`static final`

This field represents a predefined MWCtfExtractLocation instance indicating that the CTF should be extracted to a cache directory at runtime.

`EXTRACT_TO_COMPONENT_DIR` — Extract to a component directory
`static final`

This field represents a predefined MWCtfExtractLocation instance specifying that the CTF should be extracted to the directory where the component resides.

Methods

expand all

Public Methods

`apply`	`public void apply(MWComponentOptions options)` Invoke `options.setExtractLocation( this )`. Specified by: `apply` in interface `MWComponentOption`. Parameters: options The option set to which this option should be applied.
`equals`	`public boolean equals(java.lang.Object obj)` Overrides: `equals` in class `java.lang.Object`
`getExtractLocation`	`public java.lang.String getExtractLocation()` Returns the path of the directory as a string where the CTF file is set to be extracted. If the `MWCtfExtractLocation` instance has been initialized with a specific directory, this method provides the filesystem path to that directory. Returns: Path of the directory as a string where the CTF file is set to be extracted.
`hashCode`	`public int hashCode()` Overrides: `hashCode` in class `java.lang.Object`
`readResolve`	`protected java.lang.Object readResolve() throws java.io.ObjectStreamException` Parameters: index Returns: Throws: java.io.ObjectStreamException Issue during the resolution of the deserialized object.
`toString`	`public java.lang.String toString()` Overrides: `toString` in class `java.lang.Object`

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.
`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.