Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.17 / apidocs / src-html / org / apache / mina / util / byteaccess / CompositeByteArrayRelativeWriter.Flusher.html
blob: 2b243234b0fb9ed128c00367a0b6a03a8ade4c27 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.util.byteaccess;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Provides restricted, relative, write-only access to the bytes in a<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;code&gt;CompositeByteArray&lt;/code&gt;.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Using this interface has the advantage that it can be automatically<a name="line.28"></a>
<span class="sourceLineNo">029</span> * determined when a component &lt;code&gt;ByteArray&lt;/code&gt; can no longer be written<a name="line.29"></a>
<span class="sourceLineNo">030</span> * to, and thus components can be automatically flushed. This makes it easier to<a name="line.30"></a>
<span class="sourceLineNo">031</span> * use pooling for underlying &lt;code&gt;ByteArray&lt;/code&gt;s.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * By providing an appropriate &lt;code&gt;Expander&lt;/code&gt; it is also possible to<a name="line.33"></a>
<span class="sourceLineNo">034</span> * automatically add more backing storage as more data is written.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *&lt;br&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *&lt;br&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * TODO: Get flushing working.<a name="line.37"></a>
<span class="sourceLineNo">038</span> * <a name="line.38"></a>
<span class="sourceLineNo">039</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class CompositeByteArrayRelativeWriter extends CompositeByteArrayRelativeBase implements IoRelativeWriter {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * An object that knows how to expand a &lt;code&gt;CompositeByteArray&lt;/code&gt;.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> public interface Expander {<a name="line.46"></a>
<span class="sourceLineNo">047</span> void expand(CompositeByteArray cba, int minSize);<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * No-op expander. The overridden method does nothing.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * <a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public static class NopExpander implements Expander {<a name="line.54"></a>
<span class="sourceLineNo">055</span> public void expand(CompositeByteArray cba, int minSize) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> // Do nothing.<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Expands the supplied {@link CompositeByteArray} by the number of<a name="line.61"></a>
<span class="sourceLineNo">062</span> * bytes provided in the constructor<a name="line.62"></a>
<span class="sourceLineNo">063</span> * <a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public static class ChunkedExpander implements Expander {<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private final ByteArrayFactory baf;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> private final int newComponentSize;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> public ChunkedExpander(ByteArrayFactory baf, int newComponentSize) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> this.baf = baf;<a name="line.72"></a>
<span class="sourceLineNo">073</span> this.newComponentSize = newComponentSize;<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> public void expand(CompositeByteArray cba, int minSize) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> int remaining = minSize;<a name="line.77"></a>
<span class="sourceLineNo">078</span> while (remaining &gt; 0) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> ByteArray component = baf.create(newComponentSize);<a name="line.79"></a>
<span class="sourceLineNo">080</span> cba.addLast(component);<a name="line.80"></a>
<span class="sourceLineNo">081</span> remaining -= newComponentSize;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * An object that knows how to flush a &lt;code&gt;ByteArray&lt;/code&gt;.<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> public interface Flusher {<a name="line.90"></a>
<span class="sourceLineNo">091</span> // document free() behaviour<a name="line.91"></a>
<span class="sourceLineNo">092</span> void flush(ByteArray ba);<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * The expander to use when the array underflows.<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> private final Expander expander;<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * The flusher to use when flushing component &lt;code&gt;ByteArray&lt;/code&gt;s.<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> private final Flusher flusher;<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Whether or not to automatically flush a component once the cursor moves<a name="line.106"></a>
<span class="sourceLineNo">107</span> * past it.<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> private final boolean autoFlush;<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
<span class="sourceLineNo">112</span> * <a name="line.112"></a>
<span class="sourceLineNo">113</span> * Creates a new instance of CompositeByteArrayRelativeWriter.<a name="line.113"></a>
<span class="sourceLineNo">114</span> *<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @param cba<a name="line.115"></a>
<span class="sourceLineNo">116</span> * The CompositeByteArray to use to back this class<a name="line.116"></a>
<span class="sourceLineNo">117</span> * @param expander<a name="line.117"></a>
<span class="sourceLineNo">118</span> * The expander. Will increase the size of the internal ByteArray<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @param flusher<a name="line.119"></a>
<span class="sourceLineNo">120</span> * Flushed the ByteArray when necessary<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @param autoFlush<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Should this class automatically flush?<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public CompositeByteArrayRelativeWriter(CompositeByteArray cba, Expander expander, Flusher flusher,<a name="line.124"></a>
<span class="sourceLineNo">125</span> boolean autoFlush) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> super(cba);<a name="line.126"></a>
<span class="sourceLineNo">127</span> this.expander = expander;<a name="line.127"></a>
<span class="sourceLineNo">128</span> this.flusher = flusher;<a name="line.128"></a>
<span class="sourceLineNo">129</span> this.autoFlush = autoFlush;<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> private void prepareForAccess(int size) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> int underflow = cursor.getIndex() + size - last();<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (underflow &gt; 0) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> expander.expand(cba, underflow);<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> /**<a name="line.139"></a>
<span class="sourceLineNo">140</span> * Flush to the current index.<a name="line.140"></a>
<span class="sourceLineNo">141</span> */<a name="line.141"></a>
<span class="sourceLineNo">142</span> public void flush() {<a name="line.142"></a>
<span class="sourceLineNo">143</span> flushTo(cursor.getIndex());<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> /**<a name="line.146"></a>
<span class="sourceLineNo">147</span> * Flush to the given index.<a name="line.147"></a>
<span class="sourceLineNo">148</span> * <a name="line.148"></a>
<span class="sourceLineNo">149</span> * @param index The end position<a name="line.149"></a>
<span class="sourceLineNo">150</span> */<a name="line.150"></a>
<span class="sourceLineNo">151</span> public void flushTo(int index) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> ByteArray removed = cba.removeTo(index);<a name="line.152"></a>
<span class="sourceLineNo">153</span> flusher.flush(removed);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> /**<a name="line.156"></a>
<span class="sourceLineNo">157</span> * {@inheritDoc}<a name="line.157"></a>
<span class="sourceLineNo">158</span> */<a name="line.158"></a>
<span class="sourceLineNo">159</span> public void skip(int length) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> cursor.skip(length);<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span> protected void cursorPassedFirstComponent() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> if (autoFlush) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> flushTo(cba.first() + cba.getFirst().length());<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
<span class="sourceLineNo">171</span> * {@inheritDoc}<a name="line.171"></a>
<span class="sourceLineNo">172</span> */<a name="line.172"></a>
<span class="sourceLineNo">173</span> public void put(byte b) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> prepareForAccess(1);<a name="line.174"></a>
<span class="sourceLineNo">175</span> cursor.put(b);<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> /**<a name="line.178"></a>
<span class="sourceLineNo">179</span> * {@inheritDoc}<a name="line.179"></a>
<span class="sourceLineNo">180</span> */<a name="line.180"></a>
<span class="sourceLineNo">181</span> public void put(IoBuffer bb) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> prepareForAccess(bb.remaining());<a name="line.182"></a>
<span class="sourceLineNo">183</span> cursor.put(bb);<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>
<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
<span class="sourceLineNo">187</span> * {@inheritDoc}<a name="line.187"></a>
<span class="sourceLineNo">188</span> */<a name="line.188"></a>
<span class="sourceLineNo">189</span> public void putShort(short s) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> prepareForAccess(2);<a name="line.190"></a>
<span class="sourceLineNo">191</span> cursor.putShort(s);<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> /**<a name="line.194"></a>
<span class="sourceLineNo">195</span> * {@inheritDoc}<a name="line.195"></a>
<span class="sourceLineNo">196</span> */<a name="line.196"></a>
<span class="sourceLineNo">197</span> public void putInt(int i) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> prepareForAccess(4);<a name="line.198"></a>
<span class="sourceLineNo">199</span> cursor.putInt(i);<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> /**<a name="line.202"></a>
<span class="sourceLineNo">203</span> * {@inheritDoc}<a name="line.203"></a>
<span class="sourceLineNo">204</span> */<a name="line.204"></a>
<span class="sourceLineNo">205</span> public void putLong(long l) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> prepareForAccess(8);<a name="line.206"></a>
<span class="sourceLineNo">207</span> cursor.putLong(l);<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> /**<a name="line.210"></a>
<span class="sourceLineNo">211</span> * {@inheritDoc}<a name="line.211"></a>
<span class="sourceLineNo">212</span> */<a name="line.212"></a>
<span class="sourceLineNo">213</span> public void putFloat(float f) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> prepareForAccess(4);<a name="line.214"></a>
<span class="sourceLineNo">215</span> cursor.putFloat(f);<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> /**<a name="line.218"></a>
<span class="sourceLineNo">219</span> * {@inheritDoc}<a name="line.219"></a>
<span class="sourceLineNo">220</span> */<a name="line.220"></a>
<span class="sourceLineNo">221</span> public void putDouble(double d) {<a name="line.221"></a>
<span class="sourceLineNo">222</span> prepareForAccess(8);<a name="line.222"></a>
<span class="sourceLineNo">223</span> cursor.putDouble(d);<a name="line.223"></a>
<span class="sourceLineNo">224</span> }<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> /**<a name="line.226"></a>
<span class="sourceLineNo">227</span> * {@inheritDoc}<a name="line.227"></a>
<span class="sourceLineNo">228</span> */<a name="line.228"></a>
<span class="sourceLineNo">229</span> public void putChar(char c) {<a name="line.229"></a>
<span class="sourceLineNo">230</span> prepareForAccess(2);<a name="line.230"></a>
<span class="sourceLineNo">231</span> cursor.putChar(c);<a name="line.231"></a>
<span class="sourceLineNo">232</span> }<a name="line.232"></a>
<span class="sourceLineNo">233</span>}<a name="line.233"></a>
</pre>
</div>
</body>
</html>