<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="mxj" module="max" category="Languages">
	<digest>
		Execute Java in Max
	</digest>
	<description>
		Execute Java classes as Max objects. The Java classes must be specially written for Max, but work identically within the JVM (Java Virtual Machine) on both Windows and Macintosh.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Max
		</metadata>
		<metadata name="tag">
			Languages
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<!--OUTLETS-->
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="Java-class" optional="0" type="symbol">
			<digest>
				Java class file
			</digest>
			<description>
				The <o>mxj</o> object must be given the name of a valid Java class as the first argument. The Java class file must exist somewhere within the classpath, and it must be a class that was designed for use with the <o>mxj</o> object (the class must subclass com.cycling74.max.MaxObject.).
				<br />
				The number of inlets that an instance of <o>mxj</o> creates and the messages that it will respond to are determined by declarations made in the peer Java class.
			</description>
		</objarg>
		<objarg name="attributes" optional="0" type="list">
			<digest>
				User-defined attributes
			</digest>
			<description>
				The <o>mxj</o> object supports the definition of attributes within the Java code for a peer class. The attributes that are settable at the time of instantiation using the @ paradigm. For instance, if a particular class Foo defined an integer attribute called intBar, one could create an instance of the class with the attribute set to the value 74 by typing <m>mxj Foo @intBar 74</m> in an object box.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Function defined by the Java class
			</digest>
			<description>
				User-defined according to the Java class instantiated.
			</description>
		</method>
		<method name="int">
			<arglist>
				<arg name="input" optional="0" type="int" />
			</arglist>
			<digest>
				Function defined by the Java class
			</digest>
			<description>
				User-defined according to the Java class instantiated.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="input" optional="0" type="float" />
			</arglist>
			<digest>
				Function defined by the Java class
			</digest>
			<description>
				User-defined according to the Java class instantiated.
			</description>
		</method>
		<method name="list">
			<arglist>
				<arg name="input" optional="0" type="list" />
			</arglist>
			<digest>
				Function defined by the Java class
			</digest>
			<description>
				User-defined according to the Java class instantiated.
			</description>
		</method>
		<method name="anything">
			<arglist>
				<arg name="input" optional="0" type="list" />
			</arglist>
			<digest>
				Function defined by the Java class
			</digest>
			<description>
				User-defined according to the Java class instantiated.
			</description>
		</method>
		<method name="(mouse)">
			<digest>
				View and edit the Java class source code
			</digest>
			<description>
				Double-clicking with the mouse on the <o>mxj</o> object displays its contents as text in an editing window which the user can modify.
			</description>
		</method>
		<method name="get">
			<arglist>
				<arg name="attribute" optional="0" type="list" />
			</arglist>
			<digest>
				Print an attribute in the Max window
			</digest>
			<description>
				The word <m>get</m> followed by an attribute-name will post the attribute value in the Max window.
			</description>
		</method>
		<method name="viewsource">
			<arglist />
			<digest>
				View and edit the Java class source code
			</digest>
			<description>
				The <m>viewsource</m> message brings up a text editor window and loads the source code for the peer Java object. If the source code is not in the same directory as the peer class's .java file, a decompilation of the class file is attempted and the resulting decompiled source is presented. From within the editor window it's possible to make edits to the source, save the file, and recompile the class.
			</description>
		</method>
		<method name="zap">
			<arglist />
			<digest>
				Force a new instantiation of a class
			</digest>
			<description>
				When a <m>zap</m> message is sent to an <o>mxj</o> object with Java peer class Foo, the next <o>mxj</o> object that's instantiated with the same peer Java class Foo (ie typing &quot;mxj Foo&quot; in an object box) will cause the class to reload itself from disk. This is most useful in a programming context: if one makes a change to Foo.java and recompiles a new Foo.class the <m>zap</m> message allows one to create an instance of the new class without having to quit and restart the Max environment. Without sending the <m>zap</m> message Max would simply use the cached definition of the class that was loaded when a Foo object was instantiated prior to the changes being made.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="mxj.png" caption="Instantiations of the keep (in-patcher storage) and Multiplex (list multiplexing) classes" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="js" />
		<seealso name="jitterchapter51" module="jit" type="tutorial" />
	</seealsolist>
	<discussion>
		The <o>mxj</o> object and its MSP equivalent <o>mxj~</o> instantiate specially-written Java classes and act as a Max-level peer object, passing data that originates in Max to the Java object and vice versa. The form that the <o>mxj</o>/ <o>mxj~</o> object takes (the number of inlets, outlets and the messages it understands), is determined by the Java class that it instantiates.
		<br />
		<br />
		Using the <o>mxj</o> object requires that the host computer have a current version of the Java Virtual Machine (JVM) installed.
		<br />
		<br />
		Max includes a directory called &quot;java-doc&quot;, which can be found in the Max application folder.
		<br />
		<br />
		The following important subdirectories are in the java-doc directory:
		<br />
		<br />
		<m>classes</m> contains the source code and class files of the example Java classes that are included with Max.
		<br />
		<br />
		<m>help</m> contains the help files that are associated with the example Java classes. Exploring these patches is a good, quick way to see how <o>mxj</o> has extended and will extend the Max universe.
		<br />
		<br />
		<m>doc/tutorial</m> contains a step-by-step tutorial that leads you through the process of creating your first Java class to the application of advanced <o>mxj</o> programming techniques. The tutorial is in HTML format.
		<br />
		<br />
		<m>doc/api</m> contains html files that specify the <o>mxj</o> object's Application Programming Interface (API). These pages will serve as an invaluable resource when you are coding your own Java classes.
		<br />
		<br />
		<m>doc/ide</m> contains example projects for some of the Integrated Development Environments (IDEs) we think you may want to use to create Java classes.
		<br />
		<br />
		<m>lib</m> contains the code libraries that the <o>mxj</o> object uses to bridge the worlds of Max and Java.
		<br />
		<br />
		In addition, a file named max.java.config.txt. also is located in the java directory This file allows you to specify which directories should be in Java's classpath -- a concept roughly analogous to the Max search path.
	</discussion>
	<misc name="Output">
		<entry name="various">
			<description>
				The number of outlets that an instance of <o>mxj</o> creates is determined by declarations made in the constructor of the peer Java class. The furthest outlet to the right may or may not be an info outlet whose sole responsibility is to report information about the attributes when queried.
			</description>
		</entry>
	</misc>
</c74object>
