Home | History | Annotate | Download | only in base
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
      2 <!--NewPage-->
      3 <HTML>
      4 <HEAD>
      5 <!-- Generated by javadoc (build 1.6.0-google-internal) on Mon Jan 04 20:48:00 PST 2010 -->
      6 <TITLE>
      7 com.google.common.base (Guava Libraries 2010.01.04)
      8 </TITLE>
      9 
     10 <META NAME="date" CONTENT="2010-01-04">
     11 
     12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
     13 
     14 <SCRIPT type="text/javascript">
     15 function windowTitle()
     16 {
     17     if (location.href.indexOf('is-external=true') == -1) {
     18         parent.document.title="com.google.common.base (Guava Libraries 2010.01.04)";
     19     }
     20 }
     21 </SCRIPT>
     22 <NOSCRIPT>
     23 </NOSCRIPT>
     24 
     25 </HEAD>
     26 
     27 <BODY BGCOLOR="white" onload="windowTitle();">
     28 <HR>
     29 
     30 
     31 <!-- ========= START OF TOP NAVBAR ======= -->
     32 <A NAME="navbar_top"><!-- --></A>
     33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
     34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
     35 <TR>
     36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
     37 <A NAME="navbar_top_firstrow"><!-- --></A>
     38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
     39   <TR ALIGN="center" VALIGN="top">
     40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
     41   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
     42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
     43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
     44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
     45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
     46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
     47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
     48   </TR>
     49 </TABLE>
     50 </TD>
     51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
     52 </EM>
     53 </TD>
     54 </TR>
     55 
     56 <TR>
     57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     58 &nbsp;<A HREF="../../../../com/google/common/annotations/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
     59 &nbsp;<A HREF="../../../../com/google/common/collect/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
     60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     61   <A HREF="../../../../index.html?com/google/common/base/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
     62 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
     63 &nbsp;<SCRIPT type="text/javascript">
     64   <!--
     65   if(window==top) {
     66     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
     67   }
     68   //-->
     69 </SCRIPT>
     70 <NOSCRIPT>
     71   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
     72 </NOSCRIPT>
     73 
     74 
     75 </FONT></TD>
     76 </TR>
     77 </TABLE>
     78 <A NAME="skip-navbar_top"></A>
     79 <!-- ========= END OF TOP NAVBAR ========= -->
     80 
     81 <HR>
     82 <H2>
     83 Package com.google.common.base
     84 </H2>
     85 Miscellaneous common util classes and annotations.
     86 <P>
     87 <B>See:</B>
     88 <BR>
     89 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
     90 <P>
     91 
     92 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
     93 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
     94 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
     95 <B>Interface Summary</B></FONT></TH>
     96 </TR>
     97 <TR BGCOLOR="white" CLASS="TableRowColor">
     98 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/FinalizableReference.html" title="interface in com.google.common.base">FinalizableReference</A></B></TD>
     99 <TD>Implemented by references that have code to run after garbage collection of
    100  their referents.</TD>
    101 </TR>
    102 <TR BGCOLOR="white" CLASS="TableRowColor">
    103 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Function.html" title="interface in com.google.common.base">Function&lt;F,T&gt;</A></B></TD>
    104 <TD>A transformation from one object to another.</TD>
    105 </TR>
    106 <TR BGCOLOR="white" CLASS="TableRowColor">
    107 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Predicate.html" title="interface in com.google.common.base">Predicate&lt;T&gt;</A></B></TD>
    108 <TD>Determines a true or false value for a given input.</TD>
    109 </TR>
    110 <TR BGCOLOR="white" CLASS="TableRowColor">
    111 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Service.html" title="interface in com.google.common.base">Service</A></B></TD>
    112 <TD>An object with an operational state, plus asynchronous <A HREF="../../../../com/google/common/base/Service.html#start()"><CODE>Service.start()</CODE></A> and
    113  <A HREF="../../../../com/google/common/base/Service.html#stop()"><CODE>Service.stop()</CODE></A> lifecycle methods to transfer into and out of this state.</TD>
    114 </TR>
    115 <TR BGCOLOR="white" CLASS="TableRowColor">
    116 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Supplier.html" title="interface in com.google.common.base">Supplier&lt;T&gt;</A></B></TD>
    117 <TD>A class that can supply objects of a single type.</TD>
    118 </TR>
    119 </TABLE>
    120 &nbsp;
    121 
    122 <P>
    123 
    124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    127 <B>Class Summary</B></FONT></TH>
    128 </TR>
    129 <TR BGCOLOR="white" CLASS="TableRowColor">
    130 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/CharMatcher.html" title="class in com.google.common.base">CharMatcher</A></B></TD>
    131 <TD>Determines a true or false value for any Java <code>char</code> value, just as
    132  <A HREF="../../../../com/google/common/base/Predicate.html" title="interface in com.google.common.base"><CODE>Predicate</CODE></A> does for any <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><CODE>Object</CODE></A>.</TD>
    133 </TR>
    134 <TR BGCOLOR="white" CLASS="TableRowColor">
    135 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/CharMatcher.LookupTable.html" title="class in com.google.common.base">CharMatcher.LookupTable</A></B></TD>
    136 <TD>A bit array with one bit per <code>char</code> value, used by <A HREF="../../../../com/google/common/base/CharMatcher.html#precomputed()"><CODE>CharMatcher.precomputed()</CODE></A>.</TD>
    137 </TR>
    138 <TR BGCOLOR="white" CLASS="TableRowColor">
    139 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Charsets.html" title="class in com.google.common.base">Charsets</A></B></TD>
    140 <TD>Contains constant definitions for the six standard <A HREF="http://java.sun.com/javase/6/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset"><CODE>Charset</CODE></A>
    141  instances, which are guaranteed to be supported by all Java platform
    142  implementations.</TD>
    143 </TR>
    144 <TR BGCOLOR="white" CLASS="TableRowColor">
    145 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Defaults.html" title="class in com.google.common.base">Defaults</A></B></TD>
    146 <TD>This class provides default values for all Java types, as defined by the JLS.</TD>
    147 </TR>
    148 <TR BGCOLOR="white" CLASS="TableRowColor">
    149 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/FinalizablePhantomReference.html" title="class in com.google.common.base">FinalizablePhantomReference&lt;T&gt;</A></B></TD>
    150 <TD>Phantom reference with a <code>finalizeReferent()</code> method which a
    151  background thread invokes after the garbage collector reclaims the
    152  referent.</TD>
    153 </TR>
    154 <TR BGCOLOR="white" CLASS="TableRowColor">
    155 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/FinalizableReferenceQueue.html" title="class in com.google.common.base">FinalizableReferenceQueue</A></B></TD>
    156 <TD>A reference queue with an associated background thread that dequeues
    157  references and invokes <A HREF="../../../../com/google/common/base/FinalizableReference.html#finalizeReferent()"><CODE>FinalizableReference.finalizeReferent()</CODE></A> on
    158  them.</TD>
    159 </TR>
    160 <TR BGCOLOR="white" CLASS="TableRowColor">
    161 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/FinalizableSoftReference.html" title="class in com.google.common.base">FinalizableSoftReference&lt;T&gt;</A></B></TD>
    162 <TD>Soft reference with a <code>finalizeReferent()</code> method which a background
    163  thread invokes after the garbage collector reclaims the referent.</TD>
    164 </TR>
    165 <TR BGCOLOR="white" CLASS="TableRowColor">
    166 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/FinalizableWeakReference.html" title="class in com.google.common.base">FinalizableWeakReference&lt;T&gt;</A></B></TD>
    167 <TD>Weak reference with a <code>finalizeReferent()</code> method which a background
    168  thread invokes after the garbage collector reclaims the referent.</TD>
    169 </TR>
    170 <TR BGCOLOR="white" CLASS="TableRowColor">
    171 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Functions.html" title="class in com.google.common.base">Functions</A></B></TD>
    172 <TD>Useful functions.</TD>
    173 </TR>
    174 <TR BGCOLOR="white" CLASS="TableRowColor">
    175 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Joiner.html" title="class in com.google.common.base">Joiner</A></B></TD>
    176 <TD>An object which joins pieces of text (specified as an array, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><CODE>Iterable</CODE></A>, varargs or even a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A>) with a separator.</TD>
    177 </TR>
    178 <TR BGCOLOR="white" CLASS="TableRowColor">
    179 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Joiner.MapJoiner.html" title="class in com.google.common.base">Joiner.MapJoiner</A></B></TD>
    180 <TD>An object that joins map entries in the same manner as <code>Joiner</code> joins
    181  iterables and arrays.</TD>
    182 </TR>
    183 <TR BGCOLOR="white" CLASS="TableRowColor">
    184 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Objects.html" title="class in com.google.common.base">Objects</A></B></TD>
    185 <TD>Helper functions that can operate on any <code>Object</code>.</TD>
    186 </TR>
    187 <TR BGCOLOR="white" CLASS="TableRowColor">
    188 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Objects.ToStringHelper.html" title="class in com.google.common.base">Objects.ToStringHelper</A></B></TD>
    189 <TD>Support class for <A HREF="../../../../com/google/common/base/Objects.html#toStringHelper(java.lang.Object)"><CODE>Objects.toStringHelper(java.lang.Object)</CODE></A>.</TD>
    190 </TR>
    191 <TR BGCOLOR="white" CLASS="TableRowColor">
    192 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Preconditions.html" title="class in com.google.common.base">Preconditions</A></B></TD>
    193 <TD>Simple static methods to be called at the start of your own methods to verify
    194  correct arguments and state.</TD>
    195 </TR>
    196 <TR BGCOLOR="white" CLASS="TableRowColor">
    197 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Predicates.html" title="class in com.google.common.base">Predicates</A></B></TD>
    198 <TD>Contains static factory methods for creating <code>Predicate</code> instances.</TD>
    199 </TR>
    200 <TR BGCOLOR="white" CLASS="TableRowColor">
    201 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Splitter.html" title="class in com.google.common.base">Splitter</A></B></TD>
    202 <TD>An object that divides strings (or other instances of <code>CharSequence</code>)
    203  into substrings, by recognizing a <i>separator</i> (a.k.a.</TD>
    204 </TR>
    205 <TR BGCOLOR="white" CLASS="TableRowColor">
    206 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Suppliers.html" title="class in com.google.common.base">Suppliers</A></B></TD>
    207 <TD>Useful suppliers.</TD>
    208 </TR>
    209 <TR BGCOLOR="white" CLASS="TableRowColor">
    210 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Throwables.html" title="class in com.google.common.base">Throwables</A></B></TD>
    211 <TD>Static utility methods pertaining to instances of <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><CODE>Throwable</CODE></A>.</TD>
    212 </TR>
    213 </TABLE>
    214 &nbsp;
    215 
    216 <P>
    217 
    218 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    219 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    220 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    221 <B>Enum Summary</B></FONT></TH>
    222 </TR>
    223 <TR BGCOLOR="white" CLASS="TableRowColor">
    224 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/CaseFormat.html" title="enum in com.google.common.base">CaseFormat</A></B></TD>
    225 <TD>Utility class for converting between various case formats.</TD>
    226 </TR>
    227 <TR BGCOLOR="white" CLASS="TableRowColor">
    228 <TD WIDTH="15%"><B><A HREF="../../../../com/google/common/base/Service.State.html" title="enum in com.google.common.base">Service.State</A></B></TD>
    229 <TD>The lifecycle states of a service.</TD>
    230 </TR>
    231 </TABLE>
    232 &nbsp;
    233 
    234 <P>
    235 <A NAME="package_description"><!-- --></A><H2>
    236 Package com.google.common.base Description
    237 </H2>
    238 
    239 <P>
    240 Miscellaneous common util classes and annotations.
    241 <P>
    242 
    243 <P>
    244 <DL>
    245 </DL>
    246 <HR>
    247 
    248 
    249 <!-- ======= START OF BOTTOM NAVBAR ====== -->
    250 <A NAME="navbar_bottom"><!-- --></A>
    251 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    252 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    253 <TR>
    254 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    255 <A NAME="navbar_bottom_firstrow"><!-- --></A>
    256 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    257   <TR ALIGN="center" VALIGN="top">
    258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    259   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    260   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    261   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    262   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    263   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    264   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    265   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    266   </TR>
    267 </TABLE>
    268 </TD>
    269 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    270 </EM>
    271 </TD>
    272 </TR>
    273 
    274 <TR>
    275 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    276 &nbsp;<A HREF="../../../../com/google/common/annotations/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    277 &nbsp;<A HREF="../../../../com/google/common/collect/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    278 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    279   <A HREF="../../../../index.html?com/google/common/base/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    280 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    281 &nbsp;<SCRIPT type="text/javascript">
    282   <!--
    283   if(window==top) {
    284     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    285   }
    286   //-->
    287 </SCRIPT>
    288 <NOSCRIPT>
    289   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    290 </NOSCRIPT>
    291 
    292 
    293 </FONT></TD>
    294 </TR>
    295 </TABLE>
    296 <A NAME="skip-navbar_bottom"></A>
    297 <!-- ======== END OF BOTTOM NAVBAR ======= -->
    298 
    299 <HR>
    300 
    301 </BODY>
    302 </HTML>
    303