Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\util\StringUtils.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
StringUtils (Apache Ant API)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="StringUtils (Apache Ant API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<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">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/StringTokenizer.html" title="class in org.apache.tools.ant.util">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/SymbolicLinkUtils.html" title="class in org.apache.tools.ant.util">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../../index.html?org/apache/tools/ant/util/StringUtils.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="StringUtils.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

org.apache.tools.ant.util
 
Class StringUtils</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.util.StringUtils
</PRE>
<HR>
<DL>
<DT><PRE>public final class StringUtils<DT>extends java.lang.Object</DL>
</PRE>

A set of helper methods related to string manipulation.

<HR>

<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">
Field Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#LINE_SEP">LINE_SEP</A></CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the line separator for this OS</TD>
</TR>
</TABLE>
&nbsp;

<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">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#endsWith(java.lang.StringBuffer, java.lang.String)">endsWith</A>(java.lang.StringBuffer&nbsp;buffer,
 java.lang.String&nbsp;suffix)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks that a string buffer ends up with a given string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#getStackTrace(java.lang.Throwable)">getStackTrace</A>(java.lang.Throwable&nbsp;t)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenient method to retrieve the full stacktrace from a given exception.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.util.Vector</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#lineSplit(java.lang.String)">lineSplit</A>(java.lang.String&nbsp;data)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Splits up a string into a list of lines.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;long</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#parseHumanSizes(java.lang.String)">parseHumanSizes</A>(java.lang.String&nbsp;humanSize)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Takes a human readable size representation eg 10K
 a long value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#removePrefix(java.lang.String, java.lang.String)">removePrefix</A>(java.lang.String&nbsp;string,
 java.lang.String&nbsp;prefix)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the prefix from a given string, if the string contains
 that prefix.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#removeSuffix(java.lang.String, java.lang.String)">removeSuffix</A>(java.lang.String&nbsp;string,
 java.lang.String&nbsp;suffix)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the suffix from a given string, if the string contains
 that suffix.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#replace(java.lang.String, java.lang.String, java.lang.String)">replace</A>(java.lang.String&nbsp;data,
 java.lang.String&nbsp;from,
 java.lang.String&nbsp;to)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replace occurrences into a string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#resolveBackSlash(java.lang.String)">resolveBackSlash</A>(java.lang.String&nbsp;input)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xml does not do "c" like interpretation of strings.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;java.util.Vector</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/util/StringUtils.html#split(java.lang.String, int)">split</A>(java.lang.String&nbsp;data,
 int&nbsp;ch)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Splits up a string where elements are separated by a specific
 character and return all elements.</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">Methods inherited from class java.lang.Object</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;

<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">
Field Detail</TH>
</TR>
</TABLE>

<A NAME="LINE_SEP"></A><H3>
LINE_SEP</H3>
<PRE>
public static final java.lang.String LINE_SEP</PRE>
<DL>
<DD>the line separator for this OS

<DL>
</DL>
</DL>

<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">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="lineSplit(java.lang.String)"></A><H3>
lineSplit</H3>
<PRE>
public static java.util.Vector lineSplit(java.lang.String&nbsp;data)</PRE>
<DL>
<DD>Splits up a string into a list of lines. It is equivalent
 to <tt>split(data, '\n')</tt>.

<DD><DL>
<DT>Parameters:<DD><CODE>data</CODE> - the string to split up into lines.
<DT>Returns:<DD>the list of lines available in the string.</DL>
</DD>
</DL>
<HR>

<A NAME="split(java.lang.String, int)"></A><H3>
split</H3>
<PRE>
public static java.util.Vector split(java.lang.String&nbsp;data,
 int&nbsp;ch)</PRE>
<DL>
<DD>Splits up a string where elements are separated by a specific
 character and return all elements.

<DD><DL>
<DT>Parameters:<DD><CODE>data</CODE> - the string to split up.<DD><CODE>ch</CODE> - the separator character.
<DT>Returns:<DD>the list of elements.</DL>
</DD>
</DL>
<HR>

<A NAME="replace(java.lang.String, java.lang.String, java.lang.String)"></A><H3>
replace</H3>
<PRE>
public static java.lang.String replace(java.lang.String&nbsp;data,
 java.lang.String&nbsp;from,
 java.lang.String&nbsp;to)</PRE>
<DL>
<DD>Replace occurrences into a string.

<DD><DL>
<DT>Parameters:<DD><CODE>data</CODE> - the string to replace occurrences into<DD><CODE>from</CODE> - the occurrence to replace.<DD><CODE>to</CODE> - the occurrence to be used as a replacement.
<DT>Returns:<DD>the new string with replaced occurrences.</DL>
</DD>
</DL>
<HR>

<A NAME="getStackTrace(java.lang.Throwable)"></A><H3>
getStackTrace</H3>
<PRE>
public static java.lang.String getStackTrace(java.lang.Throwable&nbsp;t)</PRE>
<DL>
<DD>Convenient method to retrieve the full stacktrace from a given exception.

<DD><DL>
<DT>Parameters:<DD><CODE>t</CODE> - the exception to get the stacktrace from.
<DT>Returns:<DD>the stacktrace from the given exception.</DL>
</DD>
</DL>
<HR>

<A NAME="endsWith(java.lang.StringBuffer, java.lang.String)"></A><H3>
endsWith</H3>
<PRE>
public static boolean endsWith(java.lang.StringBuffer&nbsp;buffer,
 java.lang.String&nbsp;suffix)</PRE>
<DL>
<DD>Checks that a string buffer ends up with a given string. It may sound
 trivial with the existing
 JDK API but the various implementation among JDKs can make those
 methods extremely resource intensive
 and perform poorly due to massive memory allocation and copying. See

<DD><DL>
<DT>Parameters:<DD><CODE>buffer</CODE> - the buffer to perform the check on<DD><CODE>suffix</CODE> - the suffix
<DT>Returns:<DD><code>true</code> if the character sequence represented by the
 argument is a suffix of the character sequence represented by
 the StringBuffer object; <code>false</code> otherwise. Note that the
 result will be <code>true</code> if the argument is the
 empty string.</DL>
</DD>
</DL>
<HR>

<A NAME="resolveBackSlash(java.lang.String)"></A><H3>
resolveBackSlash</H3>
<PRE>
public static java.lang.String resolveBackSlash(java.lang.String&nbsp;input)</PRE>
<DL>
<DD>xml does not do "c" like interpretation of strings.
 i.e. \n\r\t etc.
 this method processes \n, \r, \t, \f, \\
 also subs \s -> " \n\r\t\f"
 a trailing '\' will be ignored

<DD><DL>
<DT>Parameters:<DD><CODE>input</CODE> - raw string with possible embedded '\'s
<DT>Returns:<DD>converted string<DT>Since:</DT>
 <DD>Ant 1.7</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="parseHumanSizes(java.lang.String)"></A><H3>
parseHumanSizes</H3>
<PRE>
public static long parseHumanSizes(java.lang.String&nbsp;humanSize)
 throws java.lang.Exception</PRE>
<DL>
<DD>Takes a human readable size representation eg 10K
 a long value. Doesn't support 1.1K or other rational values.

<DD><DL>
<DT>Parameters:<DD><CODE>humanSize</CODE> - the amount as a human readable string.
<DT>Returns:<DD>a long value representation
<DT>Throws:
<DD><CODE>java.lang.Exception</CODE> - if there is a problem.<DT>Since:</DT>
 <DD>Ant 1.7</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="removeSuffix(java.lang.String, java.lang.String)"></A><H3>
removeSuffix</H3>
<PRE>
public static java.lang.String removeSuffix(java.lang.String&nbsp;string,
 java.lang.String&nbsp;suffix)</PRE>
<DL>
<DD>Removes the suffix from a given string, if the string contains
 that suffix.

<DD><DL>
<DT>Parameters:<DD><CODE>string</CODE> - String for check<DD><CODE>suffix</CODE> - Suffix to remove
<DT>Returns:<DD>the string with the suffix</DL>
</DD>
</DL>
<HR>

<A NAME="removePrefix(java.lang.String, java.lang.String)"></A><H3>
removePrefix</H3>
<PRE>
public static java.lang.String removePrefix(java.lang.String&nbsp;string,
 java.lang.String&nbsp;prefix)</PRE>
<DL>
<DD>Removes the prefix from a given string, if the string contains
 that prefix.

<DD><DL>
<DT>Parameters:<DD><CODE>string</CODE> - String for check<DD><CODE>prefix</CODE> - Prefix to remove
<DT>Returns:<DD>the string with the prefix</DL>
</DD>
</DL>

<HR>

<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">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de