diff options
| author | jeffpk <[email protected]> | 2003-09-30 19:21:07 +0000 |
|---|---|---|
| committer | jeffpk <[email protected]> | 2003-09-30 19:21:07 +0000 |
| commit | 9eeea3f2222d30f0cf4b3ecd0461341b89ec85aa (patch) | |
| tree | c6bf9c4b760bdf7723c01b05753f9677abf53ea1 /apidocs/net/java/games/util/plugins/Plugins.html | |
| parent | e36e8194beb62930407086d45f9a57afa3f147fe (diff) | |
This version adds a property
"net.java.games.util.plugins.nolocalnative".
If this property is set, then ratehr then lookign in the same dir as the plugin for a plugin's native components it will fall back to the VM or platform default way of finding native libraries.
This is necessary for Java Web Start apps.
git-svn-id: file:///home/sven/projects/JOGL/git-svn/svn-server-sync/jutils/trunk@13 052365b4-98e0-4bc5-a281-465471b020e0
Diffstat (limited to 'apidocs/net/java/games/util/plugins/Plugins.html')
| -rw-r--r-- | apidocs/net/java/games/util/plugins/Plugins.html | 353 |
1 files changed, 353 insertions, 0 deletions
diff --git a/apidocs/net/java/games/util/plugins/Plugins.html b/apidocs/net/java/games/util/plugins/Plugins.html new file mode 100644 index 0000000..21aa11a --- /dev/null +++ b/apidocs/net/java/games/util/plugins/Plugins.html @@ -0,0 +1,353 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc on Tue Sep 30 12:22:52 PDT 2003 --> +<TITLE> +Plugins +</TITLE> +<META NAME="keywords" CONTENT="net.java.games.util.plugins.Plugins,Plugins class"> +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> +</HEAD> +<SCRIPT> +function asd() +{ +parent.document.title="Plugins"; +} +</SCRIPT> +<BODY BGCOLOR="white" onload="asd();"> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_top"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../net/java/games/util/plugins/PluginLoader.html"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="Plugins.html" TARGET="_top"><B>NO FRAMES</B></A> + +<SCRIPT> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> +<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> +</NOSCRIPT> +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<!-- =========== END OF NAVBAR =========== --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +net.java.games.util.plugins</FONT> +<BR> +Class Plugins</H2> +<PRE> +java.lang.Object + | + +--<B>net.java.games.util.plugins.Plugins</B> +</PRE> +<HR> +<DL> +<DT>public class <B>Plugins</B><DT>extends java.lang.Object</DL> + +<P> +This is the application interface to the Plugin system. + One Plugins object should be created for each plug-in + directory tree root. + + On creation the Plugins object will scan its assigned + directory tree and examine all Jar files in that tree to + see if they qualify as Plug-ins. + + The Plugin classes may then be retrived from the Plugins object by calling + the appropriate get function (see below). + + If a plugin requires a native code library, that library must be present + in the same directory as the plugin Jar file UNLESS the property + "net.java.games.util.plugins.nolocalnative" is set. In that case + it will fall abck to the VM or environment's default way of finding + native libraries. (This is n ecessary for Java Web Start apps.) +<P> + +<P> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../net/java/games/util/plugins/Plugins.html#Plugins(java.io.File)">Plugins</A></B>(java.io.File pluginRoot)</CODE> + +<BR> + Creates a new instance of Plugins</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Class[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/java/games/util/plugins/Plugins.html#get()">get</A></B>()</CODE> + +<BR> + This method returns all the Plugins found in the + directory passed in at object creation time or any of its + sub-directories.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Class[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/java/games/util/plugins/Plugins.html#getExtends(java.lang.Class)">getExtends</A></B>(java.lang.Class superclass)</CODE> + +<BR> + This method returns a sub-list of all the found Plugin + classes that extend the passed in Class + (either directly or through inheritance.)</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Class[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/java/games/util/plugins/Plugins.html#getImplementsAll(java.lang.Class[])">getImplementsAll</A></B>(java.lang.Class[] interfaces)</CODE> + +<BR> + This method returns a sub-list of all the found Plugin + classes that implement <B>all</B> of the passed in set of + Interfaces (either directly or through inheritance.)</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Class[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/java/games/util/plugins/Plugins.html#getImplementsAny(java.lang.Class[])">getImplementsAny</A></B>(java.lang.Class[] interfaces)</CODE> + +<BR> + This method returns a sub-list of all the found Plugin + classes that implement <B>any</B> of the passed in set of + Interfaces (either directly or through inheritance.)</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="Plugins(java.io.File)"><!-- --></A><H3> +Plugins</H3> +<PRE> +public <B>Plugins</B>(java.io.File pluginRoot) + throws java.io.IOException</PRE> +<DL> +<DD>Creates a new instance of Plugins +<P> +<DT><B>Parameters:</B><DD><CODE>pluginRoot</CODE> - The root od the directory tree to scan for Jars + containing plugins.</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="get()"><!-- --></A><H3> +get</H3> +<PRE> +public java.lang.Class[] <B>get</B>()</PRE> +<DL> +<DD>This method returns all the Plugins found in the + directory passed in at object creation time or any of its + sub-directories. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD></DL> +</DD> +</DL> +<HR> + +<A NAME="getImplementsAny(java.lang.Class[])"><!-- --></A><H3> +getImplementsAny</H3> +<PRE> +public java.lang.Class[] <B>getImplementsAny</B>(java.lang.Class[] interfaces)</PRE> +<DL> +<DD>This method returns a sub-list of all the found Plugin + classes that implement <B>any</B> of the passed in set of + Interfaces (either directly or through inheritance.) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>interfaces</CODE> - A set of interfaces to match against the interfaces + implemented by the plugin classes. +<DT><B>Returns:</B><DD>The list of plugin classes that implement at least + one member of the passed in set of interfaces.</DL> +</DD> +</DL> +<HR> + +<A NAME="getImplementsAll(java.lang.Class[])"><!-- --></A><H3> +getImplementsAll</H3> +<PRE> +public java.lang.Class[] <B>getImplementsAll</B>(java.lang.Class[] interfaces)</PRE> +<DL> +<DD>This method returns a sub-list of all the found Plugin + classes that implement <B>all</B> of the passed in set of + Interfaces (either directly or through inheritance.) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>interfaces</CODE> - A set of interfaces to match against the interfaces + implemented by the plugin classes. +<DT><B>Returns:</B><DD>The list of plugin classes that implement at least + one member of the passed in set of interfaces.</DL> +</DD> +</DL> +<HR> + +<A NAME="getExtends(java.lang.Class)"><!-- --></A><H3> +getExtends</H3> +<PRE> +public java.lang.Class[] <B>getExtends</B>(java.lang.Class superclass)</PRE> +<DL> +<DD>This method returns a sub-list of all the found Plugin + classes that extend the passed in Class + (either directly or through inheritance.) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>superclass</CODE> - The class to match. +<DT><B>Returns:</B><DD>The list of plugin classes that extend the passed + in class.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_bottom"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../net/java/games/util/plugins/PluginLoader.html"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="Plugins.html" TARGET="_top"><B>NO FRAMES</B></A> + +<SCRIPT> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> +<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> +</NOSCRIPT> +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<!-- =========== END OF NAVBAR =========== --> + +<HR> + +</BODY> +</HTML> |