/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/ArrayStack.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 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 | <!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>ArrayStack (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="ArrayStack (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>Prev Class</li>
<li><a href="../../../../org/apache/commons/collections/Bag.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/ArrayStack.html" target="_top">Frames</a></li>
<li><a href="ArrayStack.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="#fields_inherited_from_class_java.util.AbstractList">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>Field | </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.commons.collections</div>
<h2 title="Class ArrayStack" class="title">Class ArrayStack</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.AbstractCollection<E></li>
<li>
<ul class="inheritance">
<li>java.util.AbstractList<E></li>
<li>
<ul class="inheritance">
<li>java.util.ArrayList</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.ArrayStack</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess, <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ArrayStack</span>
extends java.util.ArrayList
implements <a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></pre>
<div class="block">An implementation of the <code>Stack</code> API that is based on an
<code>ArrayList</code> instead of a <code>Vector</code>, so it is not
synchronized to protect against multi-threaded access. The implementation
is therefore operates faster in environments where you do not need to
worry about multiple thread contention.
<p>
The removal order of an <code>ArrayStack</code> is based on insertion
order: The most recently added element is removed first. The iteration
order is <i>not</i> the same as the removal order. The iterator returns
elements from the bottom up, whereas the <a href="../../../../org/apache/commons/collections/ArrayStack.html#remove()"><code>remove()</code></a> method removes
them from the top down.
<p>
Unlike <code>Stack</code>, <code>ArrayStack</code> accepts null entries.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: ArrayStack.java,v 1.10.2.1 2004/05/22 12:14:01 scolebourne Exp $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Craig R. McClanahan, Paul Jack, Stephen Colebourne</dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Stack</code>,
<a href="../../../../serialized-form.html#org.apache.commons.collections.ArrayStack">Serialized Form</a></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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_java.util.AbstractList">
<!-- -->
</a>
<h3>Fields inherited from class java.util.AbstractList</h3>
<code>modCount</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#ArrayStack()">ArrayStack</a></strong>()</code>
<div class="block">Constructs a new empty <code>ArrayStack</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#ArrayStack(int)">ArrayStack</a></strong>(int initialSize)</code>
<div class="block">Constructs a new empty <code>ArrayStack</code> with an initial size.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#empty()">empty</a></strong>()</code>
<div class="block">Return <code>true</code> if this stack is currently empty.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#get()">get</a></strong>()</code>
<div class="block">Returns the element on the top of the stack.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#peek()">peek</a></strong>()</code>
<div class="block">Returns the top item off of this stack without removing it.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#peek(int)">peek</a></strong>(int n)</code>
<div class="block">Returns the n'th item down (zero-relative) from the top of this
stack without removing it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#pop()">pop</a></strong>()</code>
<div class="block">Pops the top item off of this stack and return it.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#push(java.lang.Object)">push</a></strong>(java.lang.Object item)</code>
<div class="block">Pushes a new item onto the top of this stack.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#remove()">remove</a></strong>()</code>
<div class="block">Removes the element on the top of the stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ArrayStack.html#search(java.lang.Object)">search</a></strong>(java.lang.Object object)</code>
<div class="block">Returns the one-based position of the distance from the top that the
specified object exists on this stack, where the top-most element is
considered to be at distance <code>1</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.ArrayList">
<!-- -->
</a>
<h3>Methods inherited from class java.util.ArrayList</h3>
<code>add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractList">
<!-- -->
</a>
<h3>Methods inherited from class java.util.AbstractList</h3>
<code>equals, hashCode</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection">
<!-- -->
</a>
<h3>Methods inherited from class java.util.AbstractCollection</h3>
<code>containsAll, toString</code></li>
</ul>
<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>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.Collection">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Collection</h3>
<code>add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.List">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.List</h3>
<code>containsAll, equals, hashCode</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ArrayStack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ArrayStack</h4>
<pre>public ArrayStack()</pre>
<div class="block">Constructs a new empty <code>ArrayStack</code>. The initial size
is controlled by <code>ArrayList</code> and is currently 10.</div>
</li>
</ul>
<a name="ArrayStack(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ArrayStack</h4>
<pre>public ArrayStack(int initialSize)</pre>
<div class="block">Constructs a new empty <code>ArrayStack</code> with an initial size.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialSize</code> - the initial size to use</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the specified initial size
is negative</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="empty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>empty</h4>
<pre>public boolean empty()</pre>
<div class="block">Return <code>true</code> if this stack is currently empty.
<p>
This method exists for compatability with <code>java.util.Stack</code>.
New users of this class should use <code>isEmpty</code> instead.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the stack is currently empty</dd></dl>
</li>
</ul>
<a name="get()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.Object get()</pre>
<div class="block">Returns the element on the top of the stack.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Buffer.html#get()">get</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the element on the top of the stack</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/commons/collections/BufferUnderflowException.html" title="class in org.apache.commons.collections">BufferUnderflowException</a></code> - if the stack is empty</dd></dl>
</li>
</ul>
<a name="peek()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peek</h4>
<pre>public java.lang.Object peek()
throws java.util.EmptyStackException</pre>
<div class="block">Returns the top item off of this stack without removing it.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the top item on the stack</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.util.EmptyStackException</code> - if the stack is empty</dd></dl>
</li>
</ul>
<a name="peek(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peek</h4>
<pre>public java.lang.Object peek(int n)
throws java.util.EmptyStackException</pre>
<div class="block">Returns the n'th item down (zero-relative) from the top of this
stack without removing it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - the number of items down to go</dd>
<dt><span class="strong">Returns:</span></dt><dd>the n'th item on the stack, zero relative</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.util.EmptyStackException</code> - if there are not enough items on the
stack to satisfy this request</dd></dl>
</li>
</ul>
<a name="pop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pop</h4>
<pre>public java.lang.Object pop()
throws java.util.EmptyStackException</pre>
<div class="block">Pops the top item off of this stack and return it.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the top item on the stack</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.util.EmptyStackException</code> - if the stack is empty</dd></dl>
</li>
</ul>
<a name="push(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>push</h4>
<pre>public java.lang.Object push(java.lang.Object item)</pre>
<div class="block">Pushes a new item onto the top of this stack. The pushed item is also
returned. This is equivalent to calling <code>add</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - the item to be added</dd>
<dt><span class="strong">Returns:</span></dt><dd>the item just pushed</dd></dl>
</li>
</ul>
<a name="remove()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public java.lang.Object remove()</pre>
<div class="block">Removes the element on the top of the stack.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Buffer.html#remove()">remove</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Buffer.html" title="interface in org.apache.commons.collections">Buffer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the removed element</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/commons/collections/BufferUnderflowException.html" title="class in org.apache.commons.collections">BufferUnderflowException</a></code> - if the stack is empty</dd></dl>
</li>
</ul>
<a name="search(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>search</h4>
<pre>public int search(java.lang.Object object)</pre>
<div class="block">Returns the one-based position of the distance from the top that the
specified object exists on this stack, where the top-most element is
considered to be at distance <code>1</code>. If the object is not
present on the stack, return <code>-1</code> instead. The
<code>equals()</code> method is used to compare to the items
in this stack.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - the object to be searched for</dd>
<dt><span class="strong">Returns:</span></dt><dd>the 1-based depth into the stack of the object, or -1 if not found</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>Prev Class</li>
<li><a href="../../../../org/apache/commons/collections/Bag.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/ArrayStack.html" target="_top">Frames</a></li>
<li><a href="ArrayStack.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="#fields_inherited_from_class_java.util.AbstractList">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>Field | </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><small>Copyright © 2001-2004 Apache Software Foundation. Documenation generated April 29 2013</small>.</small></p>
</body>
</html>
|