<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>log4shib: log4shib::StringUtil Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">log4shib
 <span id="projectnumber">1.0.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4shib.html">log4shib</a></li><li class="navelem"><a class="el" href="classlog4shib_1_1StringUtil.html">StringUtil</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classlog4shib_1_1StringUtil-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4shib::StringUtil Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="StringUtil_8hh_source.html">StringUtil.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac320e1ed9759117bb04538414f85c6b8"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1StringUtil.html#ac320e1ed9759117bb04538414f85c6b8">vform</a> (const char *format, va_list args)</td></tr>
<tr class="memdesc:ac320e1ed9759117bb04538414f85c6b8"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string contructed from the a format specifier and a va_list of arguments, analogously to vprintf(3). <a href="#ac320e1ed9759117bb04538414f85c6b8">More...</a><br/></td></tr>
<tr class="separator:ac320e1ed9759117bb04538414f85c6b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53ab54c8ed8e3cbe8811edbe0665bcfb"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1StringUtil.html#a53ab54c8ed8e3cbe8811edbe0665bcfb">trim</a> (const std::string &s)</td></tr>
<tr class="memdesc:a53ab54c8ed8e3cbe8811edbe0665bcfb"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string identical to the given string but without leading or trailing HTABs or spaces. <a href="#a53ab54c8ed8e3cbe8811edbe0665bcfb">More...</a><br/></td></tr>
<tr class="separator:a53ab54c8ed8e3cbe8811edbe0665bcfb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed97d911eea2afdcaf0e4f4115bf1ef9"><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1StringUtil.html#aed97d911eea2afdcaf0e4f4115bf1ef9">split</a> (std::vector< std::string > &v, const std::string &s, char delimiter, unsigned int maxSegments=INT_MAX)</td></tr>
<tr class="memdesc:aed97d911eea2afdcaf0e4f4115bf1ef9"><td class="mdescLeft"> </td><td class="mdescRight">splits a string into a vector of string segments based on the given delimiter. <a href="#aed97d911eea2afdcaf0e4f4115bf1ef9">More...</a><br/></td></tr>
<tr class="separator:aed97d911eea2afdcaf0e4f4115bf1ef9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37ab013261b14ec20e4ab2c95b93669c"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a37ab013261b14ec20e4ab2c95b93669c"><td class="memTemplItemLeft" align="right" valign="top">static unsigned int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1StringUtil.html#a37ab013261b14ec20e4ab2c95b93669c">split</a> (T &output, const std::string &s, char delimiter, unsigned int maxSegments=INT_MAX)</td></tr>
<tr class="memdesc:a37ab013261b14ec20e4ab2c95b93669c"><td class="mdescLeft"> </td><td class="mdescRight">splits a string into string segments based on the given delimiter and assigns the segments through an output_iterator. <a href="#a37ab013261b14ec20e4ab2c95b93669c">More...</a><br/></td></tr>
<tr class="separator:a37ab013261b14ec20e4ab2c95b93669c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aed97d911eea2afdcaf0e4f4115bf1ef9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int log4shib::StringUtil::split </td>
<td>(</td>
<td class="paramtype">std::vector< std::string > & </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>delimiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>maxSegments</em> = <code>INT_MAX</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>splits a string into a vector of string segments based on the given delimiter. </p>
<pre class="fragment">@param v The vector in which the segments will be stored. The vector
will be emptied before storing the segments
@param s The string to split into segments.
@param delimiter The delimiter character
@param maxSegments the maximum number of segments. Upon return
v.size() <= maxSegments. The string is scanned from left to right
so v[maxSegments - 1] may contain a string containing the delimiter
character.
</pre> <dl class="section return"><dt>Returns</dt><dd>The actual number of segments (limited by maxSegments). </dd></dl>
</div>
</div>
<a class="anchor" id="a37ab013261b14ec20e4ab2c95b93669c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static unsigned int log4shib::StringUtil::split </td>
<td>(</td>
<td class="paramtype">T & </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>delimiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>maxSegments</em> = <code>INT_MAX</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>splits a string into string segments based on the given delimiter and assigns the segments through an output_iterator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>The output_iterator through which to assign the string segments. Typically this will be a back_insertion_iterator. </td></tr>
<tr><td class="paramname">s</td><td>The string to split into segments. </td></tr>
<tr><td class="paramname">delimiter</td><td>The delimiter character </td></tr>
<tr><td class="paramname">maxSegments</td><td>The maximum number of segments. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The actual number of segments (limited by maxSegments). </dd></dl>
</div>
</div>
<a class="anchor" id="a53ab54c8ed8e3cbe8811edbe0665bcfb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string log4shib::StringUtil::trim </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string identical to the given string but without leading or trailing HTABs or spaces. </p>
</div>
</div>
<a class="anchor" id="ac320e1ed9759117bb04538414f85c6b8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string log4shib::StringUtil::vform </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string contructed from the a format specifier and a va_list of arguments, analogously to vprintf(3). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>the format specifier. </td></tr>
<tr><td class="paramname">args</td><td>the va_list of arguments. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="StringUtil_8hh_source.html">StringUtil.hh</a></li>
<li><a class="el" href="StringUtil_8cpp.html">StringUtil.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 19 2013 07:04:31 for log4shib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
