blob: e94ecba62a89fe4085504dcb608c60922ecea6eb [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: IntStack.java 468655 2006-10-28 07:12:06Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xml.utils;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.EmptyStackException;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * Implement a stack of simple integers.<a name="line.26"></a>
<FONT color="green">027</FONT> *<a name="line.27"></a>
<FONT color="green">028</FONT> * %OPT%<a name="line.28"></a>
<FONT color="green">029</FONT> * This is currently based on IntVector, which permits fast acess but pays a<a name="line.29"></a>
<FONT color="green">030</FONT> * heavy recopying penalty if/when its size is increased. If we expect deep<a name="line.30"></a>
<FONT color="green">031</FONT> * stacks, we should consider a version based on ChunkedIntVector.<a name="line.31"></a>
<FONT color="green">032</FONT> * @xsl.usage internal<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public class IntStack extends IntVector<a name="line.34"></a>
<FONT color="green">035</FONT> {<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> /**<a name="line.37"></a>
<FONT color="green">038</FONT> * Default constructor. Note that the default<a name="line.38"></a>
<FONT color="green">039</FONT> * block size is very small, for small lists.<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> public IntStack()<a name="line.41"></a>
<FONT color="green">042</FONT> {<a name="line.42"></a>
<FONT color="green">043</FONT> super();<a name="line.43"></a>
<FONT color="green">044</FONT> }<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> /**<a name="line.46"></a>
<FONT color="green">047</FONT> * Construct a IntVector, using the given block size.<a name="line.47"></a>
<FONT color="green">048</FONT> *<a name="line.48"></a>
<FONT color="green">049</FONT> * @param blocksize Size of block to allocate<a name="line.49"></a>
<FONT color="green">050</FONT> */<a name="line.50"></a>
<FONT color="green">051</FONT> public IntStack(int blocksize)<a name="line.51"></a>
<FONT color="green">052</FONT> {<a name="line.52"></a>
<FONT color="green">053</FONT> super(blocksize);<a name="line.53"></a>
<FONT color="green">054</FONT> }<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> /**<a name="line.56"></a>
<FONT color="green">057</FONT> * Copy constructor for IntStack<a name="line.57"></a>
<FONT color="green">058</FONT> * <a name="line.58"></a>
<FONT color="green">059</FONT> * @param v IntStack to copy<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public IntStack (IntStack v)<a name="line.61"></a>
<FONT color="green">062</FONT> {<a name="line.62"></a>
<FONT color="green">063</FONT> super(v);<a name="line.63"></a>
<FONT color="green">064</FONT> }<a name="line.64"></a>
<FONT color="green">065</FONT> <a name="line.65"></a>
<FONT color="green">066</FONT> /**<a name="line.66"></a>
<FONT color="green">067</FONT> * Pushes an item onto the top of this stack.<a name="line.67"></a>
<FONT color="green">068</FONT> *<a name="line.68"></a>
<FONT color="green">069</FONT> * @param i the int to be pushed onto this stack.<a name="line.69"></a>
<FONT color="green">070</FONT> * @return the &lt;code&gt;item&lt;/code&gt; argument.<a name="line.70"></a>
<FONT color="green">071</FONT> */<a name="line.71"></a>
<FONT color="green">072</FONT> public int push(int i)<a name="line.72"></a>
<FONT color="green">073</FONT> {<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> if ((m_firstFree + 1) &gt;= m_mapSize)<a name="line.75"></a>
<FONT color="green">076</FONT> {<a name="line.76"></a>
<FONT color="green">077</FONT> m_mapSize += m_blocksize;<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> int newMap[] = new int[m_mapSize];<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> System.arraycopy(m_map, 0, newMap, 0, m_firstFree + 1);<a name="line.81"></a>
<FONT color="green">082</FONT> <a name="line.82"></a>
<FONT color="green">083</FONT> m_map = newMap;<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> m_map[m_firstFree] = i;<a name="line.86"></a>
<FONT color="green">087</FONT> <a name="line.87"></a>
<FONT color="green">088</FONT> m_firstFree++;<a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> return i;<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> <a name="line.92"></a>
<FONT color="green">093</FONT> /**<a name="line.93"></a>
<FONT color="green">094</FONT> * Removes the object at the top of this stack and returns that<a name="line.94"></a>
<FONT color="green">095</FONT> * object as the value of this function.<a name="line.95"></a>
<FONT color="green">096</FONT> *<a name="line.96"></a>
<FONT color="green">097</FONT> * @return The object at the top of this stack.<a name="line.97"></a>
<FONT color="green">098</FONT> */<a name="line.98"></a>
<FONT color="green">099</FONT> public final int pop()<a name="line.99"></a>
<FONT color="green">100</FONT> {<a name="line.100"></a>
<FONT color="green">101</FONT> return m_map[--m_firstFree];<a name="line.101"></a>
<FONT color="green">102</FONT> }<a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> /**<a name="line.104"></a>
<FONT color="green">105</FONT> * Quickly pops a number of items from the stack.<a name="line.105"></a>
<FONT color="green">106</FONT> */<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> public final void quickPop(int n)<a name="line.108"></a>
<FONT color="green">109</FONT> {<a name="line.109"></a>
<FONT color="green">110</FONT> m_firstFree -= n;<a name="line.110"></a>
<FONT color="green">111</FONT> }<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> /**<a name="line.113"></a>
<FONT color="green">114</FONT> * Looks at the object at the top of this stack without removing it<a name="line.114"></a>
<FONT color="green">115</FONT> * from the stack.<a name="line.115"></a>
<FONT color="green">116</FONT> *<a name="line.116"></a>
<FONT color="green">117</FONT> * @return the object at the top of this stack.<a name="line.117"></a>
<FONT color="green">118</FONT> * @throws EmptyStackException if this stack is empty.<a name="line.118"></a>
<FONT color="green">119</FONT> */<a name="line.119"></a>
<FONT color="green">120</FONT> public final int peek()<a name="line.120"></a>
<FONT color="green">121</FONT> {<a name="line.121"></a>
<FONT color="green">122</FONT> try {<a name="line.122"></a>
<FONT color="green">123</FONT> return m_map[m_firstFree - 1];<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
<FONT color="green">125</FONT> catch (ArrayIndexOutOfBoundsException e)<a name="line.125"></a>
<FONT color="green">126</FONT> {<a name="line.126"></a>
<FONT color="green">127</FONT> throw new EmptyStackException();<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> /**<a name="line.131"></a>
<FONT color="green">132</FONT> * Looks at the object at the position the stack counting down n items.<a name="line.132"></a>
<FONT color="green">133</FONT> *<a name="line.133"></a>
<FONT color="green">134</FONT> * @param n The number of items down, indexed from zero.<a name="line.134"></a>
<FONT color="green">135</FONT> * @return the object at n items down.<a name="line.135"></a>
<FONT color="green">136</FONT> * @throws EmptyStackException if this stack is empty.<a name="line.136"></a>
<FONT color="green">137</FONT> */<a name="line.137"></a>
<FONT color="green">138</FONT> public int peek(int n)<a name="line.138"></a>
<FONT color="green">139</FONT> {<a name="line.139"></a>
<FONT color="green">140</FONT> try {<a name="line.140"></a>
<FONT color="green">141</FONT> return m_map[m_firstFree-(1+n)];<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> catch (ArrayIndexOutOfBoundsException e)<a name="line.143"></a>
<FONT color="green">144</FONT> {<a name="line.144"></a>
<FONT color="green">145</FONT> throw new EmptyStackException();<a name="line.145"></a>
<FONT color="green">146</FONT> }<a name="line.146"></a>
<FONT color="green">147</FONT> }<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> /**<a name="line.149"></a>
<FONT color="green">150</FONT> * Sets an object at a the top of the statck<a name="line.150"></a>
<FONT color="green">151</FONT> *<a name="line.151"></a>
<FONT color="green">152</FONT> *<a name="line.152"></a>
<FONT color="green">153</FONT> * @param val object to set at the top<a name="line.153"></a>
<FONT color="green">154</FONT> * @throws EmptyStackException if this stack is empty.<a name="line.154"></a>
<FONT color="green">155</FONT> */<a name="line.155"></a>
<FONT color="green">156</FONT> public void setTop(int val)<a name="line.156"></a>
<FONT color="green">157</FONT> {<a name="line.157"></a>
<FONT color="green">158</FONT> try {<a name="line.158"></a>
<FONT color="green">159</FONT> m_map[m_firstFree - 1] = val;<a name="line.159"></a>
<FONT color="green">160</FONT> }<a name="line.160"></a>
<FONT color="green">161</FONT> catch (ArrayIndexOutOfBoundsException e)<a name="line.161"></a>
<FONT color="green">162</FONT> {<a name="line.162"></a>
<FONT color="green">163</FONT> throw new EmptyStackException();<a name="line.163"></a>
<FONT color="green">164</FONT> }<a name="line.164"></a>
<FONT color="green">165</FONT> }<a name="line.165"></a>
<FONT color="green">166</FONT> <a name="line.166"></a>
<FONT color="green">167</FONT> /**<a name="line.167"></a>
<FONT color="green">168</FONT> * Tests if this stack is empty.<a name="line.168"></a>
<FONT color="green">169</FONT> *<a name="line.169"></a>
<FONT color="green">170</FONT> * @return &lt;code&gt;true&lt;/code&gt; if this stack is empty;<a name="line.170"></a>
<FONT color="green">171</FONT> * &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.171"></a>
<FONT color="green">172</FONT> * @since JDK1.0<a name="line.172"></a>
<FONT color="green">173</FONT> */<a name="line.173"></a>
<FONT color="green">174</FONT> public boolean empty()<a name="line.174"></a>
<FONT color="green">175</FONT> {<a name="line.175"></a>
<FONT color="green">176</FONT> return m_firstFree == 0;<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
<FONT color="green">178</FONT> <a name="line.178"></a>
<FONT color="green">179</FONT> /**<a name="line.179"></a>
<FONT color="green">180</FONT> * Returns where an object is on this stack.<a name="line.180"></a>
<FONT color="green">181</FONT> *<a name="line.181"></a>
<FONT color="green">182</FONT> * @param o the desired object.<a name="line.182"></a>
<FONT color="green">183</FONT> * @return the distance from the top of the stack where the object is]<a name="line.183"></a>
<FONT color="green">184</FONT> * located; the return value &lt;code&gt;-1&lt;/code&gt; indicates that the<a name="line.184"></a>
<FONT color="green">185</FONT> * object is not on the stack.<a name="line.185"></a>
<FONT color="green">186</FONT> * @since JDK1.0<a name="line.186"></a>
<FONT color="green">187</FONT> */<a name="line.187"></a>
<FONT color="green">188</FONT> public int search(int o)<a name="line.188"></a>
<FONT color="green">189</FONT> {<a name="line.189"></a>
<FONT color="green">190</FONT> <a name="line.190"></a>
<FONT color="green">191</FONT> int i = lastIndexOf(o);<a name="line.191"></a>
<FONT color="green">192</FONT> <a name="line.192"></a>
<FONT color="green">193</FONT> if (i &gt;= 0)<a name="line.193"></a>
<FONT color="green">194</FONT> {<a name="line.194"></a>
<FONT color="green">195</FONT> return size() - i;<a name="line.195"></a>
<FONT color="green">196</FONT> }<a name="line.196"></a>
<FONT color="green">197</FONT> <a name="line.197"></a>
<FONT color="green">198</FONT> return -1;<a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> <a name="line.200"></a>
<FONT color="green">201</FONT> /**<a name="line.201"></a>
<FONT color="green">202</FONT> * Returns clone of current IntStack<a name="line.202"></a>
<FONT color="green">203</FONT> * <a name="line.203"></a>
<FONT color="green">204</FONT> * @return clone of current IntStack<a name="line.204"></a>
<FONT color="green">205</FONT> */<a name="line.205"></a>
<FONT color="green">206</FONT> public Object clone()<a name="line.206"></a>
<FONT color="green">207</FONT> throws CloneNotSupportedException<a name="line.207"></a>
<FONT color="green">208</FONT> {<a name="line.208"></a>
<FONT color="green">209</FONT> return (IntStack) super.clone();<a name="line.209"></a>
<FONT color="green">210</FONT> }<a name="line.210"></a>
<FONT color="green">211</FONT> }<a name="line.211"></a>
</PRE>
</BODY>
</HTML>