You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by dl...@apache.org on 2001/06/04 02:51:30 UTC
cvs commit: jakarta-turbine/src/java/org/apache/turbine/util StringUtils.java
dlr 01/06/03 17:51:30
Modified: src/java/org/apache/turbine/util StringUtils.java
Log:
JavaDoc and variable name improvements.
Revision Changes Path
1.18 +16 -15 jakarta-turbine/src/java/org/apache/turbine/util/StringUtils.java
Index: StringUtils.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/util/StringUtils.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- StringUtils.java 2001/05/30 23:44:44 1.17
+++ StringUtils.java 2001/06/04 00:51:30 1.18
@@ -66,7 +66,7 @@
* @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
* @author <a href="mailto:gcoladonato@yahoo.com">Greg Coladonato</a>
- * @version $Id: StringUtils.java,v 1.17 2001/05/30 23:44:44 dlr Exp $
+ * @version $Id: StringUtils.java,v 1.18 2001/06/04 00:51:30 dlr Exp $
*/
public class StringUtils
{
@@ -108,24 +108,24 @@
/**
* Returns the output of printStackTrace as a String.
*
- * @param e A Throwable.
- * @return A String.
+ * @param e The source to extract a stack trace from.
+ * @return The extracted stack trace.
*/
public static final String stackTrace(Throwable e)
{
- String foo = null;
+ String trace = null;
try
{
// And show the Error Screen.
ByteArrayOutputStream buf = new ByteArrayOutputStream();
e.printStackTrace( new PrintWriter(buf, true) );
- foo = buf.toString();
+ trace = buf.toString();
}
catch (Exception f)
{
// Do nothing.
}
- return foo;
+ return trace;
}
/**
@@ -178,26 +178,27 @@
public static final int PPKEY_PROPERTY = 2;
/**
- * Takes a String of the form substring[substring]subtring and
- * returns the 3 substrings
+ * Takes a String of the form <code>substring[substring]substring</code>
+ * and returns the three parsed substrings.
*
- * @returns a three element String array
+ * @return A three element {@link java.lang.String} array populated by
+ * any parsed object key components.
*/
public static String[] parseObjectKey(String s)
{
- String[] p = new String[3];
+ String[] objectKey = new String[3];
StringTokenizer st = new StringTokenizer(s, "[]");
int count = st.countTokens();
- if ( count > 1)
+ if (count > 1)
{
- p[0] = st.nextToken();
- p[1] = st.nextToken();
+ objectKey[0] = st.nextToken();
+ objectKey[1] = st.nextToken();
if (count == 3)
{
- p[2] = st.nextToken();
+ objectKey[2] = st.nextToken();
}
}
- return p;
+ return objectKey;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org