GlueGen: src/java/com/jogamp/common/util/PrimitiveStack.java Source File

GlueGen v2.6.0-rc-20250712 GlueGen, Native Binding Generator for Java™ (public API).

PrimitiveStack.java
Go to the documentation of this file.
1/**
2 * Copyright 2012 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28package com.jogamp.common.util;
29
30/**
31 * Simple primitive-type stack.
32 */
33 public interface PrimitiveStack {
34
35 /**
36 * Returns this stack's current capacity.
37 * <p>
38 * The capacity may grow with a put operation w/ insufficient {@link #remaining()} elements left, if {@link #getGrowSize()} &gt; 0.
39 * </p>
40 */
41 int capacity();
42
43 /**
44 * Returns the current position of this stack.
45 * <p>
46 * Position is in the range: 0 &le; position &lt; {@link #capacity()}.
47 * </p>
48 * <p>
49 * The position equals to the number of elements stored.
50 * </p>
51 **/
52 int position();
53
54 /**
55 * Sets the position of this stack.
56 *
57 * @param newPosition the new position
58 * @throws IndexOutOfBoundsException if <code>newPosition</code> is outside of range: 0 &le; position &lt; {@link #capacity()}.
59 */
60 void position(int newPosition) throws IndexOutOfBoundsException;
61
62 /**
63 * Returns the remaining elements left before stack will grow about {@link #getGrowSize()}.
64 * <pre>
65 * remaining := capacity() - position();
66 * </pre>
67 * <p>
68 * 0 denotes a full stack.
69 * </p>
70 * @see #capacity()
71 * @see #position()
72 **/
73 int remaining();
74
75 /** Returns the grow size. A stack grows by this size in case a put operation exceeds it's {@link #capacity()}. */
76 int getGrowSize();
77
78 /** Set new {@link #growSize(). */
79 void setGrowSize(int newGrowSize);
80}
com.jogamp.common.util.PrimitiveStack
Simple primitive-type stack.
Definition: PrimitiveStack.java:33
com.jogamp.common.util.PrimitiveStack.getGrowSize
int getGrowSize()
Returns the grow size.
com.jogamp.common.util.PrimitiveStack.position
void position(int newPosition)
Sets the position of this stack.
com.jogamp.common.util.PrimitiveStack.position
int position()
Returns the current position of this stack.
com.jogamp.common.util.PrimitiveStack.setGrowSize
void setGrowSize(int newGrowSize)
Set new growSize().
com.jogamp.common.util.PrimitiveStack.capacity
int capacity()
Returns this stack's current capacity.
com.jogamp.common.util.PrimitiveStack.remaining
int remaining()
Returns the remaining elements left before stack will grow about getGrowSize().