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.5.0_04) on Sun Feb 19 05:15:30 PST 2006 --> 6<TITLE> 7PostalCodeEntry (JPostal API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="org.ahmadsoft.postal.PostalCodeEntry class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="/stylesheet.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="PostalCodeEntry (JPostal API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/org/ahmadsoft/postal/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 38 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PostalCodeEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 44 </TR> 45</TABLE> 46</TD> 47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 48</EM> 49</TD> 50</TR> 51 52<TR> 53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 54 <A HREF="/org/ahmadsoft/postal/PostalCodeConstants.html" title="class in org.ahmadsoft.postal"><B>PREV CLASS</B></A> 55 <A HREF="/org/ahmadsoft/postal/PostalRetrievalStrategy.html" title="interface in org.ahmadsoft.postal"><B>NEXT CLASS</B></A></FONT></TD> 56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 57 <A HREF="/index.html?org/ahmadsoft/postal/PostalCodeEntry.html" target="_top"><B>FRAMES</B></A> 58 <A HREF="PostalCodeEntry.html" target="_top"><B>NO FRAMES</B></A> 59 <SCRIPT type="text/javascript"> 60 <!-- 61 if(window==top) { 62 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 63 } 64 //--> 65</SCRIPT> 66<NOSCRIPT> 67 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 68</NOSCRIPT> 69 70 71</FONT></TD> 72</TR> 73<TR> 74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 75 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 77DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 78</TR> 79</TABLE> 80<A NAME="skip-navbar_top"></A> 81<!-- ========= END OF TOP NAVBAR ========= --> 82 83<HR> 84<!-- ======== START OF CLASS DATA ======== --> 85<H2> 86<FONT SIZE="-1"> 87org.ahmadsoft.postal</FONT> 88<BR> 89Class PostalCodeEntry</H2> 90<PRE> 91java.lang.Object 92 <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>org.ahmadsoft.postal.PostalCodeEntry</B> 93</PRE> 94<HR> 95<DL> 96<DT><PRE>public class <B>PostalCodeEntry</B><DT>extends java.lang.Object</DL> 97</PRE> 98 99<P> 100Represents a USPS recognized city, state, postal code combination. Instances 101 of this class are immutable. 102<P> 103 104<P> 105<DL> 106<DT><B>Author:</B></DT> 107 <DD>Amin Ahmad</DD> 108</DL> 109<HR> 110 111<P> 112 113<!-- ======== CONSTRUCTOR SUMMARY ======== --> 114 115<A NAME="constructor_summary"><!-- --></A> 116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 119<B>Constructor Summary</B></FONT></TH> 120</TR> 121<TR BGCOLOR="white" CLASS="TableRowColor"> 122<TD><CODE><B><A HREF="/org/ahmadsoft/postal/PostalCodeEntry.html#PostalCodeEntry(int, java.lang.String, java.lang.String, int)">PostalCodeEntry</A></B>(int postalCode, 123 java.lang.String city, 124 java.lang.String state, 125 int type)</CODE> 126 127<BR> 128 Constructs a new postal code entry.</TD> 129</TR> 130</TABLE> 131 132<!-- ========== METHOD SUMMARY =========== --> 133 134<A NAME="method_summary"><!-- --></A> 135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 137<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 138<B>Method Summary</B></FONT></TH> 139</TR> 140<TR BGCOLOR="white" CLASS="TableRowColor"> 141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 142<CODE> java.lang.String</CODE></FONT></TD> 143<TD><CODE><B><A HREF="/org/ahmadsoft/postal/PostalCodeEntry.html#getCity()">getCity</A></B>()</CODE> 144 145<BR> 146 Returns the city associated with this entry.</TD> 147</TR> 148<TR BGCOLOR="white" CLASS="TableRowColor"> 149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 150<CODE> int</CODE></FONT></TD> 151<TD><CODE><B><A HREF="/org/ahmadsoft/postal/PostalCodeEntry.html#getEntryType()">getEntryType</A></B>()</CODE> 152 153<BR> 154 Returns the type of this entry.</TD> 155</TR> 156<TR BGCOLOR="white" CLASS="TableRowColor"> 157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 158<CODE> int</CODE></FONT></TD> 159<TD><CODE><B><A HREF="/org/ahmadsoft/postal/PostalCodeEntry.html#getPostalCode()">getPostalCode</A></B>()</CODE> 160 161<BR> 162 Returns the postal code associated with this entry.</TD> 163</TR> 164<TR BGCOLOR="white" CLASS="TableRowColor"> 165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 166<CODE> java.lang.String</CODE></FONT></TD> 167<TD><CODE><B><A HREF="/org/ahmadsoft/postal/PostalCodeEntry.html#getState()">getState</A></B>()</CODE> 168 169<BR> 170 Returns the two-letter abbreviation for the state associated 171 with this entry.</TD> 172</TR> 173<TR BGCOLOR="white" CLASS="TableRowColor"> 174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 175<CODE> java.lang.String</CODE></FONT></TD> 176<TD><CODE><B><A HREF="/org/ahmadsoft/postal/PostalCodeEntry.html#toString()">toString</A></B>()</CODE> 177 178<BR> 179 </TD> 180</TR> 181</TABLE> 182 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 184<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 185<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 186</TR> 187<TR BGCOLOR="white" CLASS="TableRowColor"> 188<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> 189</TR> 190</TABLE> 191 192<P> 193 194<!-- ========= CONSTRUCTOR DETAIL ======== --> 195 196<A NAME="constructor_detail"><!-- --></A> 197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 199<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 200<B>Constructor Detail</B></FONT></TH> 201</TR> 202</TABLE> 203 204<A NAME="PostalCodeEntry(int, java.lang.String, java.lang.String, int)"><!-- --></A><H3> 205PostalCodeEntry</H3> 206<PRE> 207public <B>PostalCodeEntry</B>(int postalCode, 208 java.lang.String city, 209 java.lang.String state, 210 int type)</PRE> 211<DL> 212<DD>Constructs a new postal code entry. 213<P> 214<DL> 215<DT><B>Parameters:</B><DD><CODE>postalCode</CODE> - the postal code.<DD><CODE>city</CODE> - the city name.<DD><CODE>state</CODE> - the state.<DD><CODE>type</CODE> - the type of entry.</DL> 216</DL> 217 218<!-- ============ METHOD DETAIL ========== --> 219 220<A NAME="method_detail"><!-- --></A> 221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 222<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 223<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 224<B>Method Detail</B></FONT></TH> 225</TR> 226</TABLE> 227 228<A NAME="getCity()"><!-- --></A><H3> 229getCity</H3> 230<PRE> 231public java.lang.String <B>getCity</B>()</PRE> 232<DL> 233<DD>Returns the city associated with this entry. 234<P> 235<DD><DL> 236 237<DT><B>Returns:</B><DD>the city associated with this entry.</DL> 238</DD> 239</DL> 240<HR> 241 242<A NAME="getEntryType()"><!-- --></A><H3> 243getEntryType</H3> 244<PRE> 245public int <B>getEntryType</B>()</PRE> 246<DL> 247<DD>Returns the type of this entry. <code><a href="PostalCodeConstants.html">PostalCodeConstants.CITY*</a></code> 248 fully enumerates the valid values for this entry. 249<P> 250<DD><DL> 251 252<DT><B>Returns:</B><DD>the type of this entry.</DL> 253</DD> 254</DL> 255<HR> 256 257<A NAME="getPostalCode()"><!-- --></A><H3> 258getPostalCode</H3> 259<PRE> 260public int <B>getPostalCode</B>()</PRE> 261<DL> 262<DD>Returns the postal code associated with this entry. 263<P> 264<DD><DL> 265 266<DT><B>Returns:</B><DD>the postal code associated with this entry.</DL> 267</DD> 268</DL> 269<HR> 270 271<A NAME="getState()"><!-- --></A><H3> 272getState</H3> 273<PRE> 274public java.lang.String <B>getState</B>()</PRE> 275<DL> 276<DD>Returns the two-letter abbreviation for the state associated 277 with this entry. All valid two-letter abbreviations are 278 enumerated in <a href="http://www.usps.com/ncsc/lookups/usps_abbreviations.html"> 279 Official USPS Abbreviations</a>. 280<P> 281<DD><DL> 282 283<DT><B>Returns:</B><DD>the two-letter abbreviation for the state associated 284 with this entry.</DL> 285</DD> 286</DL> 287<HR> 288 289<A NAME="toString()"><!-- --></A><H3> 290toString</H3> 291<PRE> 292public java.lang.String <B>toString</B>()</PRE> 293<DL> 294<DD><DL> 295<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> 296</DD> 297<DD><DL> 298</DL> 299</DD> 300</DL> 301<!-- ========= END OF CLASS DATA ========= --> 302<HR> 303 304 305<!-- ======= START OF BOTTOM NAVBAR ====== --> 306<A NAME="navbar_bottom"><!-- --></A> 307<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 308<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 309<TR> 310<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 311<A NAME="navbar_bottom_firstrow"><!-- --></A> 312<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 313 <TR ALIGN="center" VALIGN="top"> 314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/org/ahmadsoft/postal/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 315 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PostalCodeEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 321 </TR> 322</TABLE> 323</TD> 324<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 325</EM> 326</TD> 327</TR> 328 329<TR> 330<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 331 <A HREF="/org/ahmadsoft/postal/PostalCodeConstants.html" title="class in org.ahmadsoft.postal"><B>PREV CLASS</B></A> 332 <A HREF="/org/ahmadsoft/postal/PostalRetrievalStrategy.html" title="interface in org.ahmadsoft.postal"><B>NEXT CLASS</B></A></FONT></TD> 333<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 334 <A HREF="/index.html?org/ahmadsoft/postal/PostalCodeEntry.html" target="_top"><B>FRAMES</B></A> 335 <A HREF="PostalCodeEntry.html" target="_top"><B>NO FRAMES</B></A> 336 <SCRIPT type="text/javascript"> 337 <!-- 338 if(window==top) { 339 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 340 } 341 //--> 342</SCRIPT> 343<NOSCRIPT> 344 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 345</NOSCRIPT> 346 347 348</FONT></TD> 349</TR> 350<TR> 351<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 352 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 354DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 355</TR> 356</TABLE> 357<A NAME="skip-navbar_bottom"></A> 358<!-- ======== END OF BOTTOM NAVBAR ======= --> 359 360<HR> 361<i>Copyright © 2006 Ahmadsoft. All Rights Reserved.</i> 362</BODY> 363</HTML> 364
