| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_92) on Mon Jul 25 12:22:03 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StringUtils (Apache Shiro 1.3.0 API)</title> |
| <meta name="date" content="2016-07-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StringUtils (Apache Shiro 1.3.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/StringUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/util/SoftHashMap.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/util/StringUtils.html" target="_top">Frames</a></li> |
| <li><a href="StringUtils.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.util</div> |
| <h2 title="Class StringUtils" class="title">Class StringUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.util.StringUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.32">StringUtils</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block"><p>Simple utility class for String operations useful across the framework. |
| <p/> |
| <p>Some methods in this class were copied from the Spring Framework so we didn't have to re-invent the wheel, |
| and in these cases, we have retained all license, copyright and author information.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static char</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#DEFAULT_DELIMITER_CHAR">DEFAULT_DELIMITER_CHAR</a></span></code> |
| <div class="block">Constant representing the default delimiter character (comma), equal to <code>','</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static char</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#DEFAULT_QUOTE_CHAR">DEFAULT_QUOTE_CHAR</a></span></code> |
| <div class="block">Constant representing the default quote character (double quote), equal to '"'</code></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#EMPTY_STRING">EMPTY_STRING</a></span></code> |
| <div class="block">Constant representing the empty string, equal to ""</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#StringUtils--">StringUtils</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#clean-java.lang.String-">clean</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> in)</code> |
| <div class="block">Returns a 'cleaned' representation of the specified argument.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#hasLength-java.lang.String-">hasLength</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code> |
| <div class="block">Check that the given String is neither <code>null</code> nor of length 0.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#hasText-java.lang.String-">hasText</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code> |
| <div class="block">Check whether the given String has actual text.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#join-java.util.Iterator-java.lang.String-">join</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><?> iterator, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> separator)</code> |
| <div class="block">Joins the elements of the provided <code>Iterator</code> into |
| a single String containing the provided elements.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#split-java.lang.String-">split</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#split-java.lang.String-char-">split</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line, |
| char delimiter)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#split-java.lang.String-char-char-">split</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line, |
| char delimiter, |
| char quoteChar)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#split-java.lang.String-char-char-char-">split</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line, |
| char delimiter, |
| char beginQuoteChar, |
| char endQuoteChar)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#split-java.lang.String-char-char-char-boolean-boolean-">split</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aLine, |
| char delimiter, |
| char beginQuoteChar, |
| char endQuoteChar, |
| boolean retainQuotes, |
| boolean trimTokens)</code> |
| <div class="block">Splits the specified delimited String into tokens, supporting quoted tokens so that quoted strings themselves |
| won't be tokenized.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#splitKeyValue-java.lang.String-">splitKeyValue</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aLine)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#splitToSet-java.lang.String-java.lang.String-">splitToSet</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimited, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> separator)</code> |
| <div class="block">Splits the <code>delimited</code> string (delimited by the specified <code>separator</code> character) and returns the |
| delimited values as a <code>Set</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#startsWithIgnoreCase-java.lang.String-java.lang.String-">startsWithIgnoreCase</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</code> |
| <div class="block">Test if the given String starts with the specified prefix, |
| ignoring upper/lower case.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#toDelimitedString-java.util.Collection-java.lang.String-">toDelimitedString</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> c, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</code> |
| <div class="block">Returns the collection's contents as a string, with each element delimited by the specified |
| <code>delimiter</code> argument.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#toDelimitedString-java.lang.Object:A-java.lang.String-">toDelimitedString</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] array, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</code> |
| <div class="block">Returns the array's contents as a string, with each element delimited by the specified |
| <code>delimiter</code> argument.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#tokenizeToStringArray-java.lang.String-java.lang.String-">tokenizeToStringArray</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiters)</code> |
| <div class="block">Tokenize the given String into a String array via a StringTokenizer.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#tokenizeToStringArray-java.lang.String-java.lang.String-boolean-boolean-">tokenizeToStringArray</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiters, |
| boolean trimTokens, |
| boolean ignoreEmptyTokens)</code> |
| <div class="block">Tokenize the given String into a String array via a StringTokenizer.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#toString-java.lang.Object:A-">toString</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] array)</code> |
| <div class="block">Returns the specified array as a comma-delimited (',') string.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#toStringArray-java.util.Collection-">toStringArray</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> collection)</code> |
| <div class="block">Copy the given Collection into a String array.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/StringUtils.html#uppercaseFirstChar-java.lang.String-">uppercaseFirstChar</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> in)</code> |
| <div class="block">Returns the input argument, but ensures the first character is capitalized (if possible).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="EMPTY_STRING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_STRING</h4> |
| <pre>public static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.39">EMPTY_STRING</a></pre> |
| <div class="block">Constant representing the empty string, equal to ""</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.shiro.util.StringUtils.EMPTY_STRING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_DELIMITER_CHAR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_DELIMITER_CHAR</h4> |
| <pre>public static final char <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.44">DEFAULT_DELIMITER_CHAR</a></pre> |
| <div class="block">Constant representing the default delimiter character (comma), equal to <code>','</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.shiro.util.StringUtils.DEFAULT_DELIMITER_CHAR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_QUOTE_CHAR"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_QUOTE_CHAR</h4> |
| <pre>public static final char <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.49">DEFAULT_QUOTE_CHAR</a></pre> |
| <div class="block">Constant representing the default quote character (double quote), equal to '"'</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.shiro.util.StringUtils.DEFAULT_QUOTE_CHAR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="StringUtils--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StringUtils</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.32">StringUtils</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="hasText-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasText</h4> |
| <pre>public static boolean <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.69">hasText</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre> |
| <div class="block">Check whether the given String has actual text. |
| More specifically, returns <code>true</code> if the string not <code>null</code>, |
| its length is greater than 0, and it contains at least one non-whitespace character. |
| <p/> |
| <code>StringUtils.hasText(null) == false<br/> |
| StringUtils.hasText("") == false<br/> |
| StringUtils.hasText(" ") == false<br/> |
| StringUtils.hasText("12345") == true<br/> |
| StringUtils.hasText(" 12345 ") == true</code> |
| <p/> |
| <p>Copied from the Spring Framework while retaining all license, copyright and author information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>str</code> - the String to check (may be <code>null</code>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the String is not <code>null</code>, its length is |
| greater than 0, and it does not contain whitespace only</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://java.sun.com/javase/6/docs/api/java/lang/Character.html?is-external=true#isWhitespace-char-" title="class or interface in java.lang"><code>Character.isWhitespace(char)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasLength-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasLength</h4> |
| <pre>public static boolean <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.97">hasLength</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre> |
| <div class="block">Check that the given String is neither <code>null</code> nor of length 0. |
| Note: Will return <code>true</code> for a String that purely consists of whitespace. |
| <p/> |
| <code>StringUtils.hasLength(null) == false<br/> |
| StringUtils.hasLength("") == false<br/> |
| StringUtils.hasLength(" ") == true<br/> |
| StringUtils.hasLength("Hello") == true</code> |
| <p/> |
| Copied from the Spring Framework while retaining all license, copyright and author information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>str</code> - the String to check (may be <code>null</code>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the String is not null and has length</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/shiro/util/StringUtils.html#hasText-java.lang.String-"><code>hasText(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startsWithIgnoreCase-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startsWithIgnoreCase</h4> |
| <pre>public static boolean <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.113">startsWithIgnoreCase</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</pre> |
| <div class="block">Test if the given String starts with the specified prefix, |
| ignoring upper/lower case. |
| <p/> |
| <p>Copied from the Spring Framework while retaining all license, copyright and author information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>str</code> - the String to check</dd> |
| <dd><code>prefix</code> - the prefix to look for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> starts with the specified prefix (ignoring case), <code>false</code> if it does not.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true#startsWith-java.lang.String-int-" title="class or interface in java.lang"><code>String.startsWith(java.lang.String, int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clean</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.144">clean</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> in)</pre> |
| <div class="block">Returns a 'cleaned' representation of the specified argument. 'Cleaned' is defined as the following: |
| <p/> |
| <ol> |
| <li>If the specified <code>String</code> is <code>null</code>, return <code>null</code></li> |
| <li>If not <code>null</code>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true#trim--" title="class or interface in java.lang"><code>trim()</code></a> it.</li> |
| <li>If the trimmed string is equal to the empty String (i.e. ""), return <code>null</code></li> |
| <li>If the trimmed string is not the empty string, return the trimmed version</li>. |
| </ol> |
| <p/> |
| Therefore this method always ensures that any given string has trimmed text, and if it doesn't, <code>null</code> |
| is returned.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>in</code> - the input String to clean.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a populated-but-trimmed String or <code>null</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.164">toString</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] array)</pre> |
| <div class="block">Returns the specified array as a comma-delimited (',') string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>array</code> - the array whose contents will be converted to a string.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the array's contents as a comma-delimited (',') string.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDelimitedString-java.lang.Object:A-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDelimitedString</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.177">toDelimitedString</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] array, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</pre> |
| <div class="block">Returns the array's contents as a string, with each element delimited by the specified |
| <code>delimiter</code> argument. Useful for <code>toString()</code> implementations and log messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>array</code> - the array whose contents will be converted to a string</dd> |
| <dd><code>delimiter</code> - the delimiter to use between each element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a single string, delimited by the specified <code>delimiter</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDelimitedString-java.util.Collection-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDelimitedString</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.200">toDelimitedString</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> c, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</pre> |
| <div class="block">Returns the collection's contents as a string, with each element delimited by the specified |
| <code>delimiter</code> argument. Useful for <code>toString()</code> implementations and log messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>c</code> - the collection whose contents will be converted to a string</dd> |
| <dd><code>delimiter</code> - the delimiter to use between each element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a single string, delimited by the specified <code>delimiter</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tokenizeToStringArray-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tokenizeToStringArray</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.224">tokenizeToStringArray</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiters)</pre> |
| <div class="block">Tokenize the given String into a String array via a StringTokenizer. |
| Trims tokens and omits empty tokens. |
| <p>The given delimiters string is supposed to consist of any number of |
| delimiter characters. Each of those characters can be used to separate |
| tokens. A delimiter is always a single character; for multi-character |
| delimiters, consider using <code>delimitedListToStringArray</code> |
| <p/> |
| <p>Copied from the Spring Framework while retaining all license, copyright and author information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>str</code> - the String to tokenize</dd> |
| <dd><code>delimiters</code> - the delimiter characters, assembled as String |
| (each of those characters is individually considered as delimiter).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of the tokens</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://java.sun.com/javase/6/docs/api/java/util/StringTokenizer.html?is-external=true" title="class or interface in java.util"><code>StringTokenizer</code></a>, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true#trim--" title="class or interface in java.lang"><code>String.trim()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tokenizeToStringArray-java.lang.String-java.lang.String-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tokenizeToStringArray</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.250">tokenizeToStringArray</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiters, |
| boolean trimTokens, |
| boolean ignoreEmptyTokens)</pre> |
| <div class="block">Tokenize the given String into a String array via a StringTokenizer. |
| <p>The given delimiters string is supposed to consist of any number of |
| delimiter characters. Each of those characters can be used to separate |
| tokens. A delimiter is always a single character; for multi-character |
| delimiters, consider using <code>delimitedListToStringArray</code> |
| <p/> |
| <p>Copied from the Spring Framework while retaining all license, copyright and author information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>str</code> - the String to tokenize</dd> |
| <dd><code>delimiters</code> - the delimiter characters, assembled as String |
| (each of those characters is individually considered as delimiter)</dd> |
| <dd><code>trimTokens</code> - trim the tokens via String's <code>trim</code></dd> |
| <dd><code>ignoreEmptyTokens</code> - omit empty tokens from the result array |
| (only applies to tokens that are empty after trimming; StringTokenizer |
| will not consider subsequent delimiters as token in the first place).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of the tokens (<code>null</code> if the input String |
| was <code>null</code>)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://java.sun.com/javase/6/docs/api/java/util/StringTokenizer.html?is-external=true" title="class or interface in java.util"><code>StringTokenizer</code></a>, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true#trim--" title="class or interface in java.lang"><code>String.trim()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toStringArray-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toStringArray</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.281">toStringArray</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> collection)</pre> |
| <div class="block">Copy the given Collection into a String array. |
| The Collection must contain String elements only. |
| <p/> |
| <p>Copied from the Spring Framework while retaining all license, copyright and author information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collection</code> - the Collection to copy</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the String array (<code>null</code> if the passed-in |
| Collection was <code>null</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="splitKeyValue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>splitKeyValue</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.288">splitKeyValue</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aLine) |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/text/ParseException.html?is-external=true" title="class or interface in java.text">ParseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="split-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>split</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.325">split</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line)</pre> |
| </li> |
| </ul> |
| <a name="split-java.lang.String-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>split</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.329">split</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line, |
| char delimiter)</pre> |
| </li> |
| </ul> |
| <a name="split-java.lang.String-char-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>split</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.333">split</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line, |
| char delimiter, |
| char quoteChar)</pre> |
| </li> |
| </ul> |
| <a name="split-java.lang.String-char-char-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>split</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.337">split</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> line, |
| char delimiter, |
| char beginQuoteChar, |
| char endQuoteChar)</pre> |
| </li> |
| </ul> |
| <a name="split-java.lang.String-char-char-char-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>split</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.361">split</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aLine, |
| char delimiter, |
| char beginQuoteChar, |
| char endQuoteChar, |
| boolean retainQuotes, |
| boolean trimTokens)</pre> |
| <div class="block">Splits the specified delimited String into tokens, supporting quoted tokens so that quoted strings themselves |
| won't be tokenized. |
| <p/> |
| This method's implementation is very loosely based (with significant modifications) on |
| <a href="http://blogs.bytecode.com.au/glen">Glen Smith</a>'s open-source |
| <a href="http://opencsv.svn.sourceforge.net/viewvc/opencsv/trunk/src/au/com/bytecode/opencsv/CSVReader.java?&view=markup">CSVReader.java</a> |
| file. |
| <p/> |
| That file is Apache 2.0 licensed as well, making Glen's code a great starting point for us to modify to |
| our needs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aLine</code> - the String to parse</dd> |
| <dd><code>delimiter</code> - the delimiter by which the <tt>line</tt> argument is to be split</dd> |
| <dd><code>beginQuoteChar</code> - the character signifying the start of quoted text (so the quoted text will not be split)</dd> |
| <dd><code>endQuoteChar</code> - the character signifying the end of quoted text</dd> |
| <dd><code>retainQuotes</code> - if the quotes themselves should be retained when constructing the corresponding token</dd> |
| <dd><code>trimTokens</code> - if leading and trailing whitespace should be trimmed from discovered tokens.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the tokens discovered from parsing the given delimited <tt>line</tt>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="join-java.util.Iterator-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>join</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.429">join</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><?> iterator, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> separator)</pre> |
| <div class="block">Joins the elements of the provided <code>Iterator</code> into |
| a single String containing the provided elements.</p> |
| <p/> |
| No delimiter is added before or after the list. |
| A <code>null</code> separator is the same as an empty String ("").</p> |
| <p/> |
| Copied from Commons Lang, version 3 (r1138702).</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>iterator</code> - the <code>Iterator</code> of values to join together, may be null</dd> |
| <dd><code>separator</code> - the separator character to use, null treated as ""</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the joined String, <code>null</code> if null iterator input</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="splitToSet-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>splitToSet</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.473">splitToSet</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimited, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> separator)</pre> |
| <div class="block">Splits the <code>delimited</code> string (delimited by the specified <code>separator</code> character) and returns the |
| delimited values as a <code>Set</code>. |
| <p/> |
| If either argument is <code>null</code>, this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delimited</code> - the string to split</dd> |
| <dd><code>separator</code> - the character that delineates individual tokens to split</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the delimited values as a <code>Set</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="uppercaseFirstChar-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>uppercaseFirstChar</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/util/StringUtils.html#line.487">uppercaseFirstChar</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> in)</pre> |
| <div class="block">Returns the input argument, but ensures the first character is capitalized (if possible).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>in</code> - the string to uppercase the first character.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the input argument, but with the first character capitalized (if possible).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/StringUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/util/SoftHashMap.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/util/StringUtils.html" target="_top">Frames</a></li> |
| <li><a href="StringUtils.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |