/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/BufferUtils.html is in libcommons-collections-java-doc 2.1.1-11.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | <!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 (version 1.7.0_21) on Mon Apr 29 13:51:59 UTC 2013 -->
<title>BufferUtils (Jakarta Commons Collections Package)</title>
<meta name="date" content="2013-04-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BufferUtils (Jakarta Commons Collections Package)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/collections/BufferUnderflowException.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/Closure.html" title="interface in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/BufferUtils.html" target="_top">Frames</a></li>
<li><a href="BufferUtils.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>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.commons.collections</div>
<h2 title="Class BufferUtils" class="title">Class BufferUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.BufferUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">BufferUtils</span>
extends java.lang.Object</pre>
<div class="block">Contains static utility methods for operating on <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections"><code>Buffer</code></a> objects.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: BufferUtils.java,v 1.9.2.1 2004/05/22 12:14:02 scolebourne Exp $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Paul Jack, Stephen Colebourne</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BufferUtils.html#blockingBuffer(org.apache.commons.collections.Buffer)">blockingBuffer</a></strong>(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer)</code>
<div class="block">Returns a synchronized buffer backed by the given buffer that will
block on <a href="../../../../org/apache/commons/collections/Buffer.html#get()"><code>Buffer.get()</code></a> and <a href="../../../../org/apache/commons/collections/Buffer.html#remove()"><code>Buffer.remove()</code></a> operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BufferUtils.html#predicatedBuffer(org.apache.commons.collections.Buffer, org.apache.commons.collections.Predicate)">predicatedBuffer</a></strong>(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</code>
<div class="block">Returns a predicated buffer backed by the given buffer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BufferUtils.html#synchronizedBuffer(org.apache.commons.collections.Buffer)">synchronizedBuffer</a></strong>(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer)</code>
<div class="block">Returns a synchronized buffer backed by the given buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BufferUtils.html#unmodifiableBuffer(org.apache.commons.collections.Buffer)">unmodifiableBuffer</a></strong>(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer)</code>
<div class="block">Returns an unmodifiable buffer backed by the given buffer.</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="blockingBuffer(org.apache.commons.collections.Buffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blockingBuffer</h4>
<pre>public static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> blockingBuffer(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer)</pre>
<div class="block">Returns a synchronized buffer backed by the given buffer that will
block on <a href="../../../../org/apache/commons/collections/Buffer.html#get()"><code>Buffer.get()</code></a> and <a href="../../../../org/apache/commons/collections/Buffer.html#remove()"><code>Buffer.remove()</code></a> operations.
If the buffer is empty, then the <a href="../../../../org/apache/commons/collections/Buffer.html#get()"><code>Buffer.get()</code></a> and
<a href="../../../../org/apache/commons/collections/Buffer.html#remove()"><code>Buffer.remove()</code></a> operations will block until new elements
are added to the buffer, rather than immediately throwing a
<code>BufferUnderflowException</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the buffer to synchronize, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a blocking buffer backed by that buffer</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Buffer is null</dd></dl>
</li>
</ul>
<a name="predicatedBuffer(org.apache.commons.collections.Buffer, org.apache.commons.collections.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>predicatedBuffer</h4>
<pre>public static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> predicatedBuffer(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</pre>
<div class="block">Returns a predicated buffer backed by the given buffer. Elements are
evaluated with the given predicate before being added to the buffer.
If the predicate evaluation returns false, then an
IllegalArgumentException is raised and the element is not added to
the buffer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the buffer to predicate, must not be null</dd><dd><code>predicate</code> - the predicate used to evaluate new elements, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a predicated buffer</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Buffer or Predicate is null</dd></dl>
</li>
</ul>
<a name="synchronizedBuffer(org.apache.commons.collections.Buffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>synchronizedBuffer</h4>
<pre>public static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> synchronizedBuffer(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer)</pre>
<div class="block">Returns a synchronized buffer backed by the given buffer.
Much like the synchronized collections returned by
<code>Collections</code>, you must manually synchronize on
the returned buffer's iterator to avoid non-deterministic behavior:
<pre>
Buffer b = BufferUtils.synchronizedBuffer(myBuffer);
synchronized (b) {
Iterator i = b.iterator();
while (i.hasNext()) {
process (i.next());
}
}
</pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the buffer to synchronize, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a synchronized buffer backed by that buffer</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Buffer is null</dd></dl>
</li>
</ul>
<a name="unmodifiableBuffer(org.apache.commons.collections.Buffer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unmodifiableBuffer</h4>
<pre>public static <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> unmodifiableBuffer(<a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a> buffer)</pre>
<div class="block">Returns an unmodifiable buffer backed by the given buffer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the buffer to make unmodifiable, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>an unmodifiable buffer backed by that buffer</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Buffer is null</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/collections/BufferUnderflowException.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/Closure.html" title="interface in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/BufferUtils.html" target="_top">Frames</a></li>
<li><a href="BufferUtils.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>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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><small>Copyright © 2001-2004 Apache Software Foundation. Documenation generated April 29 2013</small>.</small></p>
</body>
</html>
|