PageRenderTime 61ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 1ms

/lib/JSAP/doc/javadoc/com/martiansoftware/util/StringUtils.html

https://bitbucket.org/arkban/somersault
HTML | 336 lines | 270 code | 41 blank | 25 comment | 0 complexity | ca54ec724ad5673f0b5cf79125f7d12a MD5 | raw file
Possible License(s): LGPL-2.1, BSD-3-Clause, Apache-2.0
  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.4.2_08) on Thu Aug 03 20:30:44 EDT 2006 -->
  6. <TITLE>
  7. StringUtils (JSAP: the Java Simple Argument Parser)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="com.martiansoftware.util.StringUtils class">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. parent.document.title="StringUtils (JSAP: the Java Simple Argument Parser)";
  15. }
  16. </SCRIPT>
  17. </HEAD>
  18. <BODY BGCOLOR="white" onload="windowTitle();">
  19. <!-- ========= START OF TOP NAVBAR ======= -->
  20. <A NAME="navbar_top"><!-- --></A>
  21. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  22. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  23. <TR>
  24. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  25. <A NAME="navbar_top_firstrow"><!-- --></A>
  26. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  27. <TR ALIGN="center" VALIGN="top">
  28. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  29. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  30. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  31. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  32. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  35. </TR>
  36. </TABLE>
  37. </TD>
  38. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  39. </EM>
  40. </TD>
  41. </TR>
  42. <TR>
  43. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  44. &nbsp;PREV CLASS&nbsp;
  45. &nbsp;NEXT CLASS</FONT></TD>
  46. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  47. <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
  48. &nbsp;<A HREF="StringUtils.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  49. &nbsp;<SCRIPT type="text/javascript">
  50. <!--
  51. if(window==top) {
  52. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  53. }
  54. //-->
  55. </SCRIPT>
  56. <NOSCRIPT>
  57. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  58. </NOSCRIPT>
  59. </FONT></TD>
  60. </TR>
  61. <TR>
  62. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  63. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  65. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  66. </TR>
  67. </TABLE>
  68. <A NAME="skip-navbar_top"></A>
  69. <!-- ========= END OF TOP NAVBAR ========= -->
  70. <HR>
  71. <!-- ======== START OF CLASS DATA ======== -->
  72. <H2>
  73. <FONT SIZE="-1">
  74. com.martiansoftware.util</FONT>
  75. <BR>
  76. Class StringUtils</H2>
  77. <PRE>
  78. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
  79. <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>com.martiansoftware.util.StringUtils</B>
  80. </PRE>
  81. <HR>
  82. <DL>
  83. <DT>public final class <B>StringUtils</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
  84. <P>
  85. <DL>
  86. <DT><B>Author:</B></DT>
  87. <DD><a href="http://www.martiansoftware.com/contact.html">Marty Lamb</a></DD>
  88. </DL>
  89. <HR>
  90. <P>
  91. <!-- ======== NESTED CLASS SUMMARY ======== -->
  92. <!-- =========== FIELD SUMMARY =========== -->
  93. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  94. <A NAME="constructor_summary"><!-- --></A>
  95. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  96. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  97. <TD COLSPAN=2><FONT SIZE="+2">
  98. <B>Constructor Summary</B></FONT></TD>
  99. </TR>
  100. <TR BGCOLOR="white" CLASS="TableRowColor">
  101. <TD><CODE><B><A HREF="../../../com/martiansoftware/util/StringUtils.html#StringUtils()">StringUtils</A></B>()</CODE>
  102. <BR>
  103. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  104. </TR>
  105. </TABLE>
  106. &nbsp;
  107. <!-- ========== METHOD SUMMARY =========== -->
  108. <A NAME="method_summary"><!-- --></A>
  109. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  110. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  111. <TD COLSPAN=2><FONT SIZE="+2">
  112. <B>Method Summary</B></FONT></TD>
  113. </TR>
  114. <TR BGCOLOR="white" CLASS="TableRowColor">
  115. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  116. <CODE>static&nbsp;void</CODE></FONT></TD>
  117. <TD><CODE><B><A HREF="../../../com/martiansoftware/util/StringUtils.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)</CODE>
  118. <BR>
  119. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  120. </TR>
  121. <TR BGCOLOR="white" CLASS="TableRowColor">
  122. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  123. <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  124. <TD><CODE><B><A HREF="../../../com/martiansoftware/util/StringUtils.html#noNull(java.lang.String)">noNull</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s)</CODE>
  125. <BR>
  126. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  127. </TR>
  128. <TR BGCOLOR="white" CLASS="TableRowColor">
  129. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  130. <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  131. <TD><CODE><B><A HREF="../../../com/martiansoftware/util/StringUtils.html#padRight(java.lang.String, int)">padRight</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s,
  132. int&nbsp;padCount)</CODE>
  133. <BR>
  134. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  135. </TR>
  136. <TR BGCOLOR="white" CLASS="TableRowColor">
  137. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  138. <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  139. <TD><CODE><B><A HREF="../../../com/martiansoftware/util/StringUtils.html#padRightToWidth(java.lang.String, int)">padRightToWidth</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s,
  140. int&nbsp;desiredWidth)</CODE>
  141. <BR>
  142. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  143. </TR>
  144. <TR BGCOLOR="white" CLASS="TableRowColor">
  145. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  146. <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html" title="class or interface in java.util">List</A></CODE></FONT></TD>
  147. <TD><CODE><B><A HREF="../../../com/martiansoftware/util/StringUtils.html#wrapToList(java.lang.String, int)">wrapToList</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s,
  148. int&nbsp;width)</CODE>
  149. <BR>
  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  151. </TR>
  152. </TABLE>
  153. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  154. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  155. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  156. <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
  157. </TR>
  158. <TR BGCOLOR="white" CLASS="TableRowColor">
  159. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
  160. </TR>
  161. </TABLE>
  162. &nbsp;
  163. <P>
  164. <!-- ============ FIELD DETAIL =========== -->
  165. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  166. <A NAME="constructor_detail"><!-- --></A>
  167. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  168. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  169. <TD COLSPAN=1><FONT SIZE="+2">
  170. <B>Constructor Detail</B></FONT></TD>
  171. </TR>
  172. </TABLE>
  173. <A NAME="StringUtils()"><!-- --></A><H3>
  174. StringUtils</H3>
  175. <PRE>
  176. public <B>StringUtils</B>()</PRE>
  177. <DL>
  178. </DL>
  179. <!-- ============ METHOD DETAIL ========== -->
  180. <A NAME="method_detail"><!-- --></A>
  181. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  182. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  183. <TD COLSPAN=1><FONT SIZE="+2">
  184. <B>Method Detail</B></FONT></TD>
  185. </TR>
  186. </TABLE>
  187. <A NAME="noNull(java.lang.String)"><!-- --></A><H3>
  188. noNull</H3>
  189. <PRE>
  190. public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>noNull</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s)</PRE>
  191. <DL>
  192. <DD><DL>
  193. </DL>
  194. </DD>
  195. </DL>
  196. <HR>
  197. <A NAME="padRight(java.lang.String, int)"><!-- --></A><H3>
  198. padRight</H3>
  199. <PRE>
  200. public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>padRight</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s,
  201. int&nbsp;padCount)</PRE>
  202. <DL>
  203. <DD><DL>
  204. </DL>
  205. </DD>
  206. </DL>
  207. <HR>
  208. <A NAME="padRightToWidth(java.lang.String, int)"><!-- --></A><H3>
  209. padRightToWidth</H3>
  210. <PRE>
  211. public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>padRightToWidth</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s,
  212. int&nbsp;desiredWidth)</PRE>
  213. <DL>
  214. <DD><DL>
  215. </DL>
  216. </DD>
  217. </DL>
  218. <HR>
  219. <A NAME="wrapToList(java.lang.String, int)"><!-- --></A><H3>
  220. wrapToList</H3>
  221. <PRE>
  222. public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>wrapToList</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;s,
  223. int&nbsp;width)</PRE>
  224. <DL>
  225. <DD><DL>
  226. </DL>
  227. </DD>
  228. </DL>
  229. <HR>
  230. <A NAME="main(java.lang.String[])"><!-- --></A><H3>
  231. main</H3>
  232. <PRE>
  233. public static void <B>main</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)</PRE>
  234. <DL>
  235. <DD><DL>
  236. </DL>
  237. </DD>
  238. </DL>
  239. <!-- ========= END OF CLASS DATA ========= -->
  240. <HR>
  241. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  242. <A NAME="navbar_bottom"><!-- --></A>
  243. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  244. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  245. <TR>
  246. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  247. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  248. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  249. <TR ALIGN="center" VALIGN="top">
  250. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  251. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  252. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  253. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  254. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  255. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  256. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  257. </TR>
  258. </TABLE>
  259. </TD>
  260. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  261. </EM>
  262. </TD>
  263. </TR>
  264. <TR>
  265. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  266. &nbsp;PREV CLASS&nbsp;
  267. &nbsp;NEXT CLASS</FONT></TD>
  268. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  269. <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
  270. &nbsp;<A HREF="StringUtils.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  271. &nbsp;<SCRIPT type="text/javascript">
  272. <!--
  273. if(window==top) {
  274. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  275. }
  276. //-->
  277. </SCRIPT>
  278. <NOSCRIPT>
  279. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  280. </NOSCRIPT>
  281. </FONT></TD>
  282. </TR>
  283. <TR>
  284. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  285. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  286. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  287. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  288. </TR>
  289. </TABLE>
  290. <A NAME="skip-navbar_bottom"></A>
  291. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  292. <HR>
  293. Copyright &copy; 2002-2006, Martian Software, Inc.. All Rights Reserved.<br>For the latest version and documentation, please visit <a href='http://www.martiansoftware.com/jsap'>http://www.martiansoftware.com/jsap</a>
  294. </BODY>
  295. </HTML>