blob: be2e4728acf21c2d43b69328856e24931f1b5345 [file] [log] [blame]
<!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_16) on Fri Nov 14 01:27:19 PST 2008 -->
<TITLE>
Types (Guice 1.0 API)
</TITLE>
<META NAME="keywords" CONTENT="com.google.inject.util.Types class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Types (Guice 1.0 API)";
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/google/inject/util/Providers.html" title="class in com.google.inject.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/google/inject/util/Types.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Types.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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">
com.google.inject.util</FONT>
<BR>
Class Types</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.inject.util.Types</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Types</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Static methods for working with types.
<P>
<P>
<HR>
<P>
<!-- ========== 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>static&nbsp;java.lang.reflect.GenericArrayType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#arrayOf(java.lang.reflect.Type)">arrayOf</A></B>(java.lang.reflect.Type&nbsp;componentType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array type whose elements are all instances of
<code>componentType</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.ParameterizedType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#listOf(java.lang.reflect.Type)">listOf</A></B>(java.lang.reflect.Type&nbsp;elementType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a type modelling a <CODE>List</CODE> whose elements are of type
<code>elementType</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.ParameterizedType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#mapOf(java.lang.reflect.Type, java.lang.reflect.Type)">mapOf</A></B>(java.lang.reflect.Type&nbsp;keyType,
java.lang.reflect.Type&nbsp;valueType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a type modelling a <CODE>Map</CODE> whose keys are of type
<code>keyType</code> and whose values are of type <code>valueType</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.ParameterizedType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#newParameterizedType(java.lang.reflect.Type, java.lang.reflect.Type...)">newParameterizedType</A></B>(java.lang.reflect.Type&nbsp;rawType,
java.lang.reflect.Type...&nbsp;typeArguments)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new parameterized type, applying <code>typeArguments</code> to
<code>rawType</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.ParameterizedType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#newParameterizedTypeWithOwner(java.lang.reflect.Type, java.lang.reflect.Type, java.lang.reflect.Type...)">newParameterizedTypeWithOwner</A></B>(java.lang.reflect.Type&nbsp;ownerType,
java.lang.reflect.Type&nbsp;rawType,
java.lang.reflect.Type...&nbsp;typeArguments)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new parameterized type, applying <code>typeArguments</code> to
<code>rawType</code> and enclosed by <code>ownerType</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.ParameterizedType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#providerOf(java.lang.reflect.Type)">providerOf</A></B>(java.lang.reflect.Type&nbsp;providedType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a type modelling a <A HREF="../../../../com/google/inject/Provider.html" title="interface in com.google.inject"><CODE>Provider</CODE></A> that provides elements of type
<code>elementType</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.ParameterizedType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#setOf(java.lang.reflect.Type)">setOf</A></B>(java.lang.reflect.Type&nbsp;elementType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a type modelling a <CODE>Set</CODE> whose elements are of type
<code>elementType</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.WildcardType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#subtypeOf(java.lang.reflect.Type)">subtypeOf</A></B>(java.lang.reflect.Type&nbsp;bound)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a type that represents an unknown type that extends <code>bound</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.reflect.WildcardType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/inject/util/Types.html#supertypeOf(java.lang.reflect.Type)">supertypeOf</A></B>(java.lang.reflect.Type&nbsp;bound)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a type that represents an unknown supertype of <code>bound</code>.</TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;
<P>
<!-- ============ 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="newParameterizedType(java.lang.reflect.Type, java.lang.reflect.Type...)"><!-- --></A><H3>
newParameterizedType</H3>
<PRE>
public static java.lang.reflect.ParameterizedType <B>newParameterizedType</B>(java.lang.reflect.Type&nbsp;rawType,
java.lang.reflect.Type...&nbsp;typeArguments)</PRE>
<DL>
<DD>Returns a new parameterized type, applying <code>typeArguments</code> to
<code>rawType</code>. The returned type does not have an owner type.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>serializable</CODE> parameterized type.</DL>
</DD>
</DL>
<HR>
<A NAME="newParameterizedTypeWithOwner(java.lang.reflect.Type, java.lang.reflect.Type, java.lang.reflect.Type...)"><!-- --></A><H3>
newParameterizedTypeWithOwner</H3>
<PRE>
public static java.lang.reflect.ParameterizedType <B>newParameterizedTypeWithOwner</B>(java.lang.reflect.Type&nbsp;ownerType,
java.lang.reflect.Type&nbsp;rawType,
java.lang.reflect.Type...&nbsp;typeArguments)</PRE>
<DL>
<DD>Returns a new parameterized type, applying <code>typeArguments</code> to
<code>rawType</code> and enclosed by <code>ownerType</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>serializable</CODE> parameterized type.</DL>
</DD>
</DL>
<HR>
<A NAME="arrayOf(java.lang.reflect.Type)"><!-- --></A><H3>
arrayOf</H3>
<PRE>
public static java.lang.reflect.GenericArrayType <B>arrayOf</B>(java.lang.reflect.Type&nbsp;componentType)</PRE>
<DL>
<DD>Returns an array type whose elements are all instances of
<code>componentType</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>serializable</CODE> generic array type.</DL>
</DD>
</DL>
<HR>
<A NAME="subtypeOf(java.lang.reflect.Type)"><!-- --></A><H3>
subtypeOf</H3>
<PRE>
public static java.lang.reflect.WildcardType <B>subtypeOf</B>(java.lang.reflect.Type&nbsp;bound)</PRE>
<DL>
<DD>Returns a type that represents an unknown type that extends <code>bound</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="supertypeOf(java.lang.reflect.Type)"><!-- --></A><H3>
supertypeOf</H3>
<PRE>
public static java.lang.reflect.WildcardType <B>supertypeOf</B>(java.lang.reflect.Type&nbsp;bound)</PRE>
<DL>
<DD>Returns a type that represents an unknown supertype of <code>bound</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="listOf(java.lang.reflect.Type)"><!-- --></A><H3>
listOf</H3>
<PRE>
public static java.lang.reflect.ParameterizedType <B>listOf</B>(java.lang.reflect.Type&nbsp;elementType)</PRE>
<DL>
<DD>Returns a type modelling a <CODE>List</CODE> whose elements are of type
<code>elementType</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>serializable</CODE> parameterized type.</DL>
</DD>
</DL>
<HR>
<A NAME="setOf(java.lang.reflect.Type)"><!-- --></A><H3>
setOf</H3>
<PRE>
public static java.lang.reflect.ParameterizedType <B>setOf</B>(java.lang.reflect.Type&nbsp;elementType)</PRE>
<DL>
<DD>Returns a type modelling a <CODE>Set</CODE> whose elements are of type
<code>elementType</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>serializable</CODE> parameterized type.</DL>
</DD>
</DL>
<HR>
<A NAME="mapOf(java.lang.reflect.Type, java.lang.reflect.Type)"><!-- --></A><H3>
mapOf</H3>
<PRE>
public static java.lang.reflect.ParameterizedType <B>mapOf</B>(java.lang.reflect.Type&nbsp;keyType,
java.lang.reflect.Type&nbsp;valueType)</PRE>
<DL>
<DD>Returns a type modelling a <CODE>Map</CODE> whose keys are of type
<code>keyType</code> and whose values are of type <code>valueType</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>serializable</CODE> parameterized type.</DL>
</DD>
</DL>
<HR>
<A NAME="providerOf(java.lang.reflect.Type)"><!-- --></A><H3>
providerOf</H3>
<PRE>
public static java.lang.reflect.ParameterizedType <B>providerOf</B>(java.lang.reflect.Type&nbsp;providedType)</PRE>
<DL>
<DD>Returns a type modelling a <A HREF="../../../../com/google/inject/Provider.html" title="interface in com.google.inject"><CODE>Provider</CODE></A> that provides elements of type
<code>elementType</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>serializable</CODE> parameterized type.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/google/inject/util/Providers.html" title="class in com.google.inject.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/google/inject/util/Types.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Types.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>