| <!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.5.0_14) on Mon Apr 26 10:16:12 PDT 2010 --> | |
| <TITLE> | |
| ClassTool (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.ClassTool class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ClassTool (VelocityTools 2.0 Documentation)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= 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/velocity/tools/generic/AlternatorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.CallableSub.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ClassTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ClassTool.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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.velocity.tools.generic</FONT> | |
| <BR> | |
| Class ClassTool</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.SafeConfig</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.ClassTool</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE><FONT SIZE="-1"><A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html" title="annotation in org.apache.velocity.tools.config">@DefaultKey</A>(<A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html#value()">value</A>="class") | |
| </FONT>public class <B>ClassTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></DL> | |
| </PRE> | |
| <P> | |
| <p> | |
| This tool is meant to simplify reflective lookup of information about | |
| a <CODE>Class</CODE> and its <CODE>Field</CODE>s, <CODE>Method</CODE>s, and <CODE>Constructor</CODE>s. | |
| This is ideally aimed at those wishing to generate documentation, demo code, or | |
| other content based on runtime reflection of a specified Class or Classes. It was not | |
| designed with reflective execution of code in mind and thus provides no facilities | |
| for code execution, nor direct access to the actual methods, constructors or fields | |
| of the class being inspected. | |
| </p> | |
| <p> | |
| <pre> | |
| Example tools.xml config: | |
| <tools> | |
| <toolbox scope="application"> | |
| <tool class="org.apache.velocity.tools.generic.ClassTool" | |
| inspect="com.org.Foo"/> | |
| </toolbox> | |
| </tools> | |
| </pre></p> | |
| <p> | |
| If no Class to be inspected is specified, the default is java.lang.Object. | |
| </p> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Since:</B></DT> | |
| <DD>VelocityTools 2.0</DD> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: ClassTool.java 463298 2006-10-12 16:10:32Z henning $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Nathan Bubna</DD> | |
| </DL> | |
| <HR> | |
| <P> | |
| <!-- ======== NESTED CLASS SUMMARY ======== --> | |
| <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.CallableSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.CallableSub</A><<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.CallableSub.html" title="type parameter in ClassTool.CallableSub">T</A> extends <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.CallableSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.CallableSub</A>></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.ConstructorSub</A></B></CODE> | |
| <BR> | |
| A simplified wrapping interface for inspecting features | |
| of a <CODE>Constructor</CODE> in an inspected Class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.FieldSub</A></B></CODE> | |
| <BR> | |
| A simplified wrapping interface for inspecting features | |
| of a <CODE>Field</CODE> in an inspected Class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.MethodSub</A></B></CODE> | |
| <BR> | |
| A simplified wrapping interface for inspecting features | |
| of a <CODE>Method</CODE> in an inspected Class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.Sub.html" title="class in org.apache.velocity.tools.generic">ClassTool.Sub</A><<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.Sub.html" title="type parameter in ClassTool.Sub">T</A> extends <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.Sub.html" title="class in org.apache.velocity.tools.generic">ClassTool.Sub</A>></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <A NAME="field_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>Field Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.ConstructorSub</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#constructors">constructors</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.FieldSub</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#fields">fields</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#INSPECT_KEY">INSPECT_KEY</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected org.apache.velocity.runtime.log.Log</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#log">log</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.MethodSub</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#methods">methods</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#SHOW_DEPRECATED_KEY">SHOW_DEPRECATED_KEY</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#showDeprecated">showDeprecated</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.lang.Class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#type">type</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOCK_CONFIG_KEY">LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#OLD_LOCK_CONFIG_KEY">OLD_LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#SAFE_MODE_KEY">SAFE_MODE_KEY</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ======== 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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> </CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#ClassTool()">ClassTool</A></B>()</CODE> | |
| <BR> | |
| Creates an instance with target type of <CODE>Object</CODE>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected </CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#ClassTool(org.apache.velocity.tools.generic.ClassTool, java.lang.Class)">ClassTool</A></B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A> tool, | |
| java.lang.Class type)</CODE> | |
| <BR> | |
| Creates a new instance that inspects the specified type | |
| and otherwise shares the configuration values of the specified "parent" | |
| ClassTool instance.</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>private void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#addType(java.util.Set, java.lang.Class)">addType</A></B>(java.util.Set<java.lang.Class> types, | |
| java.lang.Class type)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> values)</CODE> | |
| <BR> | |
| Does the actual configuration.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.List<java.lang.annotation.Annotation></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#getAnnotations()">getAnnotations</A></B>()</CODE> | |
| <BR> | |
| Returns the <CODE>Annotation</CODE>s of the Class being inspected.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.ConstructorSub</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#getConstructors()">getConstructors</A></B>()</CODE> | |
| <BR> | |
| Returns a <CODE>List</CODE> of <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic"><CODE>ClassTool.ConstructorSub</CODE></A>s for each | |
| constructor declared constructor in the inspected class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.FieldSub</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#getFields()">getFields</A></B>()</CODE> | |
| <BR> | |
| Returns a <CODE>List</CODE> of <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic"><CODE>ClassTool.FieldSub</CODE></A>s for each | |
| field declared field in the inspected class.</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/velocity/tools/generic/ClassTool.html#getFullName()">getFullName</A></B>()</CODE> | |
| <BR> | |
| Returns the fully-qualified name for the inspected Class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.MethodSub</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#getMethods()">getMethods</A></B>()</CODE> | |
| <BR> | |
| Returns a <CODE>List</CODE> of <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic"><CODE>ClassTool.MethodSub</CODE></A>s for each | |
| method declared method in the inspected class.</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/velocity/tools/generic/ClassTool.html#getName()">getName</A></B>()</CODE> | |
| <BR> | |
| Returns the simple name (i.e.</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/velocity/tools/generic/ClassTool.html#getPackage()">getPackage</A></B>()</CODE> | |
| <BR> | |
| Returns the name of the package to which the inspected Class belongs.</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/velocity/tools/generic/ClassTool.html#getShowDeprecated()">getShowDeprecated</A></B>()</CODE> | |
| <BR> | |
| Returns the current showDeprecated setting.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#getSuper()">getSuper</A></B>()</CODE> | |
| <BR> | |
| Returns a new ClassTool instance that is inspecting the | |
| superclass of the Class being inspected by this instance.</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="../../../../../org/apache/velocity/tools/generic/ClassTool.html#getType()">getType</A></B>()</CODE> | |
| <BR> | |
| Returns the <CODE>Class</CODE> being inspected by this instance.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Set<java.lang.Class></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#getTypes()">getTypes</A></B>()</CODE> | |
| <BR> | |
| Returns a <CODE>Set</CODE> of all <CODE>Class</CODE>es that are | |
| part of the signatures (i.e.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#inspect(java.lang.Class)">inspect</A></B>(java.lang.Class type)</CODE> | |
| <BR> | |
| Returns a new ClassTool instance that is inspecting the | |
| the specified <CODE>Class</CODE>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#inspect(java.lang.Object)">inspect</A></B>(java.lang.Object obj)</CODE> | |
| <BR> | |
| Returns a new ClassTool instance that is inspecting the | |
| Class of the specified <CODE>Object</CODE>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#inspect(java.lang.String)">inspect</A></B>(java.lang.String name)</CODE> | |
| <BR> | |
| Returns a new ClassTool instance that is inspecting the | |
| Class with the specified name.</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/velocity/tools/generic/ClassTool.html#isAbstract()">isAbstract</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is declared abstract.</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/velocity/tools/generic/ClassTool.html#isDeprecated()">isDeprecated</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class has been deprecated.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#isDeprecated(java.lang.reflect.AnnotatedElement)">isDeprecated</A></B>(java.lang.reflect.AnnotatedElement element)</CODE> | |
| <BR> | |
| </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/velocity/tools/generic/ClassTool.html#isFinal()">isFinal</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is declared final.</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/velocity/tools/generic/ClassTool.html#isInterface()">isInterface</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is an 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/velocity/tools/generic/ClassTool.html#isPrivate()">isPrivate</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is declared private.</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/velocity/tools/generic/ClassTool.html#isProtected()">isProtected</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is declared protected.</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/velocity/tools/generic/ClassTool.html#isPublic()">isPublic</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is declared public.</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/velocity/tools/generic/ClassTool.html#isStatic()">isStatic</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is an inner class | |
| that has been declared static or is a standard outer class..</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/velocity/tools/generic/ClassTool.html#isStrict()">isStrict</A></B>()</CODE> | |
| <BR> | |
| Returns true if the inspected Class is declared strictfp | |
| (uses strict floating point math).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#setType(java.lang.Class)">setType</A></B>(java.lang.Class type)</CODE> | |
| <BR> | |
| </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/velocity/tools/generic/ClassTool.html#supportsNewInstance()">supportsNewInstance</A></B>()</CODE> | |
| <BR> | |
| Returns true if a call to newInstance() on the Class being | |
| inspected is successful; otherwise returns false.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.lang.Class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html#toClass(java.lang.String)">toClass</A></B>(java.lang.String name)</CODE> | |
| <BR> | |
| </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/velocity/tools/generic/ClassTool.html#toString()">toString</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(java.util.Map)">configure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isConfigLocked()">isConfigLocked</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode()">isSafeMode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setLockConfig(boolean)">setLockConfig</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setSafeMode(boolean)">setSafeMode</A></CODE></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, wait, wait, wait</CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <A NAME="field_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>Field Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="INSPECT_KEY"><!-- --></A><H3> | |
| INSPECT_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>INSPECT_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ClassTool.INSPECT_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="SHOW_DEPRECATED_KEY"><!-- --></A><H3> | |
| SHOW_DEPRECATED_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>SHOW_DEPRECATED_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ClassTool.SHOW_DEPRECATED_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="log"><!-- --></A><H3> | |
| log</H3> | |
| <PRE> | |
| protected org.apache.velocity.runtime.log.Log <B>log</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="type"><!-- --></A><H3> | |
| type</H3> | |
| <PRE> | |
| protected java.lang.Class <B>type</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="methods"><!-- --></A><H3> | |
| methods</H3> | |
| <PRE> | |
| protected java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.MethodSub</A>> <B>methods</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="constructors"><!-- --></A><H3> | |
| constructors</H3> | |
| <PRE> | |
| protected java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.ConstructorSub</A>> <B>constructors</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="fields"><!-- --></A><H3> | |
| fields</H3> | |
| <PRE> | |
| protected java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.FieldSub</A>> <B>fields</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="showDeprecated"><!-- --></A><H3> | |
| showDeprecated</H3> | |
| <PRE> | |
| private boolean <B>showDeprecated</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <!-- ========= 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="ClassTool()"><!-- --></A><H3> | |
| ClassTool</H3> | |
| <PRE> | |
| public <B>ClassTool</B>()</PRE> | |
| <DL> | |
| <DD>Creates an instance with target type of <CODE>Object</CODE>. | |
| <P> | |
| </DL> | |
| <HR> | |
| <A NAME="ClassTool(org.apache.velocity.tools.generic.ClassTool, java.lang.Class)"><!-- --></A><H3> | |
| ClassTool</H3> | |
| <PRE> | |
| protected <B>ClassTool</B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A> tool, | |
| java.lang.Class type)</PRE> | |
| <DL> | |
| <DD>Creates a new instance that inspects the specified type | |
| and otherwise shares the configuration values of the specified "parent" | |
| ClassTool instance. | |
| <P> | |
| </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="configure(org.apache.velocity.tools.generic.ValueParser)"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| protected void <B>configure</B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> values)</PRE> | |
| <DL> | |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(org.apache.velocity.tools.generic.ValueParser)">SafeConfig</A></CODE></B></DD> | |
| <DD>Does the actual configuration. This is protected, so | |
| subclasses may share the same ValueParser and call configure | |
| at any time, while preventing templates from doing so when | |
| configure(Map) is locked. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toClass(java.lang.String)"><!-- --></A><H3> | |
| toClass</H3> | |
| <PRE> | |
| private java.lang.Class <B>toClass</B>(java.lang.String name)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setType(java.lang.Class)"><!-- --></A><H3> | |
| setType</H3> | |
| <PRE> | |
| protected void <B>setType</B>(java.lang.Class type)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isDeprecated(java.lang.reflect.AnnotatedElement)"><!-- --></A><H3> | |
| isDeprecated</H3> | |
| <PRE> | |
| protected static boolean <B>isDeprecated</B>(java.lang.reflect.AnnotatedElement element)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getShowDeprecated()"><!-- --></A><H3> | |
| getShowDeprecated</H3> | |
| <PRE> | |
| public boolean <B>getShowDeprecated</B>()</PRE> | |
| <DL> | |
| <DD>Returns the current showDeprecated setting. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getType()"><!-- --></A><H3> | |
| getType</H3> | |
| <PRE> | |
| public java.lang.Class <B>getType</B>()</PRE> | |
| <DL> | |
| <DD>Returns the <CODE>Class</CODE> being inspected by this instance. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="inspect(java.lang.String)"><!-- --></A><H3> | |
| inspect</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A> <B>inspect</B>(java.lang.String name)</PRE> | |
| <DL> | |
| <DD>Returns a new ClassTool instance that is inspecting the | |
| Class with the specified name. If the specified Class cannot | |
| be found, then this will return <code>null</code>. All other | |
| configuration settings will be copied to the new instance. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="inspect(java.lang.Object)"><!-- --></A><H3> | |
| inspect</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A> <B>inspect</B>(java.lang.Object obj)</PRE> | |
| <DL> | |
| <DD>Returns a new ClassTool instance that is inspecting the | |
| Class of the specified <CODE>Object</CODE>. If the specified object | |
| is null, then this will return <code>null</code>. All other | |
| configuration settings will be copied to the new instance. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getSuper()"><!-- --></A><H3> | |
| getSuper</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A> <B>getSuper</B>()</PRE> | |
| <DL> | |
| <DD>Returns a new ClassTool instance that is inspecting the | |
| superclass of the Class being inspected by this instance. | |
| If the current inspectee has no super class, | |
| then this will return <code>null</code>. All other | |
| configuration settings will be copied to the new instance. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="inspect(java.lang.Class)"><!-- --></A><H3> | |
| inspect</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A> <B>inspect</B>(java.lang.Class type)</PRE> | |
| <DL> | |
| <DD>Returns a new ClassTool instance that is inspecting the | |
| the specified <CODE>Class</CODE>. If the specified class | |
| is null, then this will return <code>null</code>. All other | |
| configuration settings will be copied to the new instance. | |
| If <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode()"><CODE>SafeConfig.isSafeMode()</CODE></A> is <code>true</code> and the specified Class | |
| is not declared <code>public</code>, then this will return | |
| <code>null</code>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getPackage()"><!-- --></A><H3> | |
| getPackage</H3> | |
| <PRE> | |
| public java.lang.String <B>getPackage</B>()</PRE> | |
| <DL> | |
| <DD>Returns the name of the package to which the inspected Class belongs. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getName()"><!-- --></A><H3> | |
| getName</H3> | |
| <PRE> | |
| public java.lang.String <B>getName</B>()</PRE> | |
| <DL> | |
| <DD>Returns the simple name (i.e. full name with package name removed) of | |
| the inspected Class. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFullName()"><!-- --></A><H3> | |
| getFullName</H3> | |
| <PRE> | |
| public java.lang.String <B>getFullName</B>()</PRE> | |
| <DL> | |
| <DD>Returns the fully-qualified name for the inspected Class. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="supportsNewInstance()"><!-- --></A><H3> | |
| supportsNewInstance</H3> | |
| <PRE> | |
| public boolean <B>supportsNewInstance</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if a call to newInstance() on the Class being | |
| inspected is successful; otherwise returns false. Unlike calling | |
| newInstance() directly from a template, this will not throw an | |
| Exception if it fails, as all Exceptions are caught. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isDeprecated()"><!-- --></A><H3> | |
| isDeprecated</H3> | |
| <PRE> | |
| public boolean <B>isDeprecated</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class has been deprecated. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isPublic()"><!-- --></A><H3> | |
| isPublic</H3> | |
| <PRE> | |
| public boolean <B>isPublic</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is declared public. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isProtected()"><!-- --></A><H3> | |
| isProtected</H3> | |
| <PRE> | |
| public boolean <B>isProtected</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is declared protected. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isPrivate()"><!-- --></A><H3> | |
| isPrivate</H3> | |
| <PRE> | |
| public boolean <B>isPrivate</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is declared private. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isStatic()"><!-- --></A><H3> | |
| isStatic</H3> | |
| <PRE> | |
| public boolean <B>isStatic</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is an inner class | |
| that has been declared static or is a standard outer class.. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isFinal()"><!-- --></A><H3> | |
| isFinal</H3> | |
| <PRE> | |
| public boolean <B>isFinal</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is declared final. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isInterface()"><!-- --></A><H3> | |
| isInterface</H3> | |
| <PRE> | |
| public boolean <B>isInterface</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is an interface. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isStrict()"><!-- --></A><H3> | |
| isStrict</H3> | |
| <PRE> | |
| public boolean <B>isStrict</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is declared strictfp | |
| (uses strict floating point math). | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isAbstract()"><!-- --></A><H3> | |
| isAbstract</H3> | |
| <PRE> | |
| public boolean <B>isAbstract</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the inspected Class is declared abstract. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getMethods()"><!-- --></A><H3> | |
| getMethods</H3> | |
| <PRE> | |
| public java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.MethodSub</A>> <B>getMethods</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <CODE>List</CODE> of <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic"><CODE>ClassTool.MethodSub</CODE></A>s for each | |
| method declared method in the inspected class. However, | |
| in safe mode (which *is* the default), this will only return | |
| the public methods. You must configure safe mode to be off | |
| to receive a list of all methods. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getConstructors()"><!-- --></A><H3> | |
| getConstructors</H3> | |
| <PRE> | |
| public java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.ConstructorSub</A>> <B>getConstructors</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <CODE>List</CODE> of <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic"><CODE>ClassTool.ConstructorSub</CODE></A>s for each | |
| constructor declared constructor in the inspected class. However, | |
| in safe mode (which *is* the default), this will only return | |
| the public constructors. You must configure safe mode to be off | |
| to receive a list of all constructors. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFields()"><!-- --></A><H3> | |
| getFields</H3> | |
| <PRE> | |
| public java.util.List<<A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.FieldSub</A>> <B>getFields</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <CODE>List</CODE> of <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic"><CODE>ClassTool.FieldSub</CODE></A>s for each | |
| field declared field in the inspected class. However, | |
| in safe mode (which *is* the default), this will only return | |
| the public fields. You must configure safe mode to be off | |
| to receive a list of all fields. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getTypes()"><!-- --></A><H3> | |
| getTypes</H3> | |
| <PRE> | |
| public java.util.Set<java.lang.Class> <B>getTypes</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <CODE>Set</CODE> of all <CODE>Class</CODE>es that are | |
| part of the signatures (i.e. parameters or return types) | |
| of the inspected Class's methods, constructors and fields. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addType(java.util.Set, java.lang.Class)"><!-- --></A><H3> | |
| addType</H3> | |
| <PRE> | |
| private void <B>addType</B>(java.util.Set<java.lang.Class> types, | |
| java.lang.Class type)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAnnotations()"><!-- --></A><H3> | |
| getAnnotations</H3> | |
| <PRE> | |
| public java.util.List<java.lang.annotation.Annotation> <B>getAnnotations</B>()</PRE> | |
| <DL> | |
| <DD>Returns the <CODE>Annotation</CODE>s of the Class being inspected. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toString()"><!-- --></A><H3> | |
| toString</H3> | |
| <PRE> | |
| public java.lang.String <B>toString</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </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/velocity/tools/generic/AlternatorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.CallableSub.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ClassTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ClassTool.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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> | |
| Copyright (c) 2003-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |