<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Sat Dec 04 05:26:45 UTC 2010 --> <TITLE> InterfaceDescription </TITLE> <META NAME="date" CONTENT="2010-12-04"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="InterfaceDescription"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <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="../../../../../../org/apache/ws/jaxme/js/pattern/CompiledClassReflector.html" title="class in org.apache.ws.jaxme.js.pattern"><B>PREV CLASS</B></A> <A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/MethodKey.html" title="class in org.apache.ws.jaxme.js.pattern"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?org/apache/ws/jaxme/js/pattern/InterfaceDescription.html" target="_top"><B>FRAMES</B></A> <A HREF="InterfaceDescription.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><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> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.ws.jaxme.js.pattern</FONT> <BR> Class InterfaceDescription</H2> <PRE> java.lang.Object <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.ws.jaxme.js.pattern.InterfaceDescription</B> </PRE> <HR> <DL> <DT><PRE>public class <B>InterfaceDescription</B><DT>extends java.lang.Object</DL> </PRE> <P> The <code>InterfaceDescription</code> is used by the <A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/ProxyGenerator.html" title="class in org.apache.ws.jaxme.js.pattern"><CODE>ProxyGenerator</CODE></A> as information storage about the interfaces being implemented.<br> The main purporse of an intermediate class is to encapsulate the way, how information about these classes is gathered: <ol> <li>If the interface being implemented is a compiled class, then Java reflection is used.</li> <li>Otherwise, if the interface being implemented is present as a Java source file, then the <A HREF="../../../../../../org/apache/ws/jaxme/js/util/JavaParser.html" title="class in org.apache.ws.jaxme.js.util"><CODE>JavaParser</CODE></A> is used.</li> </ol <P> <P> <HR> <P> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#InterfaceDescription()">InterfaceDescription</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#getInterface()">getInterface</A></B>()</CODE> <BR> Returns the name of the interface being implemented.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../../org/apache/ws/jaxme/js/JavaSource.html" title="class in org.apache.ws.jaxme.js">JavaSource</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#getJavaSource()">getJavaSource</A></B>()</CODE> <BR> Returns an instance of <A HREF="../../../../../../org/apache/ws/jaxme/js/JavaSource.html" title="class in org.apache.ws.jaxme.js"><CODE>JavaSource</CODE></A>, matching the interface <A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#getInterface()"><CODE>getInterface()</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#getType()">getType</A></B>()</CODE> <BR> Returns, how to gather information about the interface.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#isMandatory()">isMandatory</A></B>()</CODE> <BR> Returns whether this interface is mandatory.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#setInterface(java.lang.String)">setInterface</A></B>(java.lang.String pName)</CODE> <BR> Sets the name of the interface being implemented.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#setMandatory(boolean)">setMandatory</A></B>(boolean pMandatory)</CODE> <BR> Sets whether this interface is mandatory.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#setType(java.lang.String)">setType</A></B>(java.lang.String pType)</CODE> <BR> Sets, how to gather information about the interface.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="InterfaceDescription()"><!-- --></A><H3> InterfaceDescription</H3> <PRE> public <B>InterfaceDescription</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="setInterface(java.lang.String)"><!-- --></A><H3> setInterface</H3> <PRE> public void <B>setInterface</B>(java.lang.String pName)</PRE> <DL> <DD>Sets the name of the interface being implemented. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getInterface()"><!-- --></A><H3> getInterface</H3> <PRE> public java.lang.String <B>getInterface</B>()</PRE> <DL> <DD>Returns the name of the interface being implemented. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setType(java.lang.String)"><!-- --></A><H3> setType</H3> <PRE> public void <B>setType</B>(java.lang.String pType)</PRE> <DL> <DD>Sets, how to gather information about the interface. Supported values are "Reflection" (Java reflection), or "Source" (<A HREF="../../../../../../org/apache/ws/jaxme/js/util/JavaParser.html" title="class in org.apache.ws.jaxme.js.util"><CODE>JavaParser</CODE></A>). The default is null, in which case "Reflection" and "Source" are tried, in that order. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getType()"><!-- --></A><H3> getType</H3> <PRE> public java.lang.String <B>getType</B>()</PRE> <DL> <DD>Returns, how to gather information about the interface. Supported values are "Reflection" (Java reflection), or "Source" (<A HREF="../../../../../../org/apache/ws/jaxme/js/util/JavaParser.html" title="class in org.apache.ws.jaxme.js.util"><CODE>JavaParser</CODE></A>). The default is null, in which case "Reflection" and "Source" are tried, in that order. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setMandatory(boolean)"><!-- --></A><H3> setMandatory</H3> <PRE> public void <B>setMandatory</B>(boolean pMandatory)</PRE> <DL> <DD>Sets whether this interface is mandatory. By default interfaces are mandatory and the backing objects must implement this interface. If an interface isn't mandatory, then a Proxy instance can be created even for objects which don't implement the interface. However, in that case it may happen that a ClassCastException is thrown while invoking a method declared by the interface. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isMandatory()"><!-- --></A><H3> isMandatory</H3> <PRE> public boolean <B>isMandatory</B>()</PRE> <DL> <DD>Returns whether this interface is mandatory. By default interfaces are mandatory and the backing objects must implement this interface. If an interface isn't mandatory, then a Proxy instance can be created even for objects which don't implement the interface. However, in that case it may happen that a ClassCastException is thrown while invoking a method declared by the interface. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getJavaSource()"><!-- --></A><H3> getJavaSource</H3> <PRE> public <A HREF="../../../../../../org/apache/ws/jaxme/js/JavaSource.html" title="class in org.apache.ws.jaxme.js">JavaSource</A> <B>getJavaSource</B>() throws java.lang.Exception</PRE> <DL> <DD>Returns an instance of <A HREF="../../../../../../org/apache/ws/jaxme/js/JavaSource.html" title="class in org.apache.ws.jaxme.js"><CODE>JavaSource</CODE></A>, matching the interface <A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/InterfaceDescription.html#getInterface()"><CODE>getInterface()</CODE></A>. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <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="../../../../../../org/apache/ws/jaxme/js/pattern/CompiledClassReflector.html" title="class in org.apache.ws.jaxme.js.pattern"><B>PREV CLASS</B></A> <A HREF="../../../../../../org/apache/ws/jaxme/js/pattern/MethodKey.html" title="class in org.apache.ws.jaxme.js.pattern"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?org/apache/ws/jaxme/js/pattern/InterfaceDescription.html" target="_top"><B>FRAMES</B></A> <A HREF="InterfaceDescription.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><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> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>