Modified: websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html ============================================================================== --- websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html (original) +++ websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html Sat Feb 4 16:19:37 2017 @@ -29,237 +29,235 @@ <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream; <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException; <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.compressors.CompressorOutputStream; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.utils.ByteUtils; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * CompressorOutputStream for the LZ4 frame format.</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.compressors.CompressorOutputStream; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.utils.ByteUtils; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * CompressorOutputStream for the LZ4 frame format.</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * <p>Based on the "spec" in the version "1.5.1 (31/03/2015)"</p></em> <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * <p>Based on the "spec" in the version "1.5.1 (31/03/2015)"</p></em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://lz4.github.io/lz4/lz4_Frame_format.html" target="alexandria_uri">http://lz4.github.io/lz4/lz4_Frame_format.html</a>">LZ4 Frame Format Description</a></em> -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * @since 1.14</em> -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @NotThreadSafe</em> -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">FramedLZ4CompressorOutputStream</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/commons/compress/compressors/CompressorOutputStream.html">CompressorOutputStream</a> { -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_comment"> * TODO before releasing 1.14:</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_comment"> * + block dependence</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://lz4.github.io/lz4/lz4_Frame_format.html" target="alexandria_uri">http://lz4.github.io/lz4/lz4_Frame_format.html</a>">LZ4 Frame Format Description</a></em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @since 1.14</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @NotThreadSafe</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">FramedLZ4CompressorOutputStream</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/commons/compress/compressors/CompressorOutputStream.html">CompressorOutputStream</a> { +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_comment"> * TODO before releasing 1.14:</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_comment"> * + block dependence</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] END_MARK = <strong class="jxr_keyword">new</strong> byte[4]; <a class="jxr_linenumber" name="L45" href="#L45">45</a> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] END_MARK = <strong class="jxr_keyword">new</strong> byte[4]; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">// used in one-arg write method</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> byte[] oneByte = <strong class="jxr_keyword">new</strong> byte[1]; -<a class="jxr_linenumber" name="L50" href="#L50">50</a> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> byte[] blockData; -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> OutputStream out; -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> params; -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> finished = false; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> currentIndex = 0; -<a class="jxr_linenumber" name="L56" href="#L56">56</a> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_comment">// used for frame header checksum and content checksum, if requested</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a> contentHash = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a>(); -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_comment">// used for block checksum, if requested</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a> blockHash; -<a class="jxr_linenumber" name="L61" href="#L61">61</a> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * The block sizes supported by the format.</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> { -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/** Block size of 64K */</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> K64(64 * 1024, 0), -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/** Block size of 256K */</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> K256(256 * 1024, 1), -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/** Block size of 1M */</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> M1(1024 * 1024, 2), -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/** Block size of 4M */</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> M4(1024 * 1024, 4); -<a class="jxr_linenumber" name="L74" href="#L74">74</a> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> size, index; -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a>(<strong class="jxr_keyword">int</strong> size, <strong class="jxr_keyword">int</strong> index) { -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">this</strong>.size = size; -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">this</strong>.index = index; -<a class="jxr_linenumber" name="L79" href="#L79">79</a> } -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">int</strong> getSize() { -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">return</strong> size; -<a class="jxr_linenumber" name="L82" href="#L82">82</a> } -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">int</strong> getIndex() { -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> index; -<a class="jxr_linenumber" name="L85" href="#L85">85</a> } -<a class="jxr_linenumber" name="L86" href="#L86">86</a> } -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Parameters of the LZ4 frame format.</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> { -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> blockSize; -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> withContentChecksum, withBlockChecksum; -<a class="jxr_linenumber" name="L94" href="#L94">94</a> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * The default parameters of 4M block size, enabled content</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * checksum, disabled block checksums and independent blocks.</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <p>This matches the defaults of the lz4 command line utility.</p></em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> DEFAULT = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a>(BlockSize.M4, <strong class="jxr_keyword">true</strong>, false); -<a class="jxr_linenumber" name="L102" href="#L102">102</a> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Sets up custom a custom block size for the LZ4 stream but</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * otherwise uses the defaults of enabled content checksum,</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * disabled block checksums and independent blocks.</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param blockSize the size of a single block.</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a>(<a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> blockSize) { -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">this</strong>(blockSize, <strong class="jxr_keyword">true</strong>, false); -<a class="jxr_linenumber" name="L111" href="#L111">111</a> } -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * Sets up custom parameters for the LZ4 stream.</em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @param blockSize the size of a single block.</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @param withContentChecksum whether to write a content checksum</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @param withBlockChecksum whether to write a block checksum.</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Note that block checksums are not supported by the lz4</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * command line utility</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a>(<a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> blockSize, <strong class="jxr_keyword">boolean</strong> withContentChecksum, <strong class="jxr_keyword">boolean</strong> withBlockChecksum) { -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">this</strong>.blockSize = blockSize; -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">this</strong>.withContentChecksum = withContentChecksum; -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">this</strong>.withBlockChecksum = withBlockChecksum; -<a class="jxr_linenumber" name="L124" href="#L124">124</a> } -<a class="jxr_linenumber" name="L125" href="#L125">125</a> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> @Override -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">public</strong> String toString() { -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"LZ4 Parameters with BlockSize "</span> + blockSize + <span class="jxr_string">", withContentChecksum "</span> + withContentChecksum -<a class="jxr_linenumber" name="L129" href="#L129">129</a> + <span class="jxr_string">", withBlockChecksum "</span> + withBlockChecksum; -<a class="jxr_linenumber" name="L130" href="#L130">130</a> } -<a class="jxr_linenumber" name="L131" href="#L131">131</a> } -<a class="jxr_linenumber" name="L132" href="#L132">132</a> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Constructs a new output stream that compresses data using the</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * LZ4 frame format using the default block size of 4MB.</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @param out the OutputStream to which to write the compressed data</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @throws IOException if writing the signature fails</em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">FramedLZ4CompressorOutputStream</a>(OutputStream out) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">this</strong>(out, Parameters.DEFAULT); -<a class="jxr_linenumber" name="L141" href="#L141">141</a> } -<a class="jxr_linenumber" name="L142" href="#L142">142</a> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Constructs a new output stream that compresses data using the</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * LZ4 frame format using the given block size.</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @param out the OutputStream to which to write the compressed data</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @param params the parameters to use</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @throws IOException if writing the signature fails</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">FramedLZ4CompressorOutputStream</a>(OutputStream out, <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> params) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">this</strong>.params = params; -<a class="jxr_linenumber" name="L152" href="#L152">152</a> blockData = <strong class="jxr_keyword">new</strong> byte[params.blockSize.getSize()]; -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">this</strong>.out = out; -<a class="jxr_linenumber" name="L154" href="#L154">154</a> blockHash = params.withBlockChecksum ? <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a>() : <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L155" href="#L155">155</a> out.write(FramedLZ4CompressorInputStream.LZ4_SIGNATURE); -<a class="jxr_linenumber" name="L156" href="#L156">156</a> writeFrameDescriptor(); -<a class="jxr_linenumber" name="L157" href="#L157">157</a> } -<a class="jxr_linenumber" name="L158" href="#L158">158</a> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> @Override -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(<strong class="jxr_keyword">int</strong> b) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L161" href="#L161">161</a> oneByte[0] = (byte) (b & 0xff); -<a class="jxr_linenumber" name="L162" href="#L162">162</a> write(oneByte); -<a class="jxr_linenumber" name="L163" href="#L163">163</a> } -<a class="jxr_linenumber" name="L164" href="#L164">164</a> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> @Override -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(byte[] data, <strong class="jxr_keyword">int</strong> off, <strong class="jxr_keyword">int</strong> len) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L167" href="#L167">167</a> contentHash.update(data, off, len); -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> (currentIndex + len > blockData.length) { -<a class="jxr_linenumber" name="L169" href="#L169">169</a> flushBlock(); -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">while</strong> (len > blockData.length) { -<a class="jxr_linenumber" name="L171" href="#L171">171</a> System.arraycopy(data, off, blockData, 0, blockData.length); -<a class="jxr_linenumber" name="L172" href="#L172">172</a> off += blockData.length; -<a class="jxr_linenumber" name="L173" href="#L173">173</a> len -= blockData.length; -<a class="jxr_linenumber" name="L174" href="#L174">174</a> currentIndex = blockData.length; -<a class="jxr_linenumber" name="L175" href="#L175">175</a> flushBlock(); -<a class="jxr_linenumber" name="L176" href="#L176">176</a> } -<a class="jxr_linenumber" name="L177" href="#L177">177</a> } -<a class="jxr_linenumber" name="L178" href="#L178">178</a> System.arraycopy(data, off, blockData, currentIndex, len); -<a class="jxr_linenumber" name="L179" href="#L179">179</a> currentIndex += len; -<a class="jxr_linenumber" name="L180" href="#L180">180</a> } -<a class="jxr_linenumber" name="L181" href="#L181">181</a> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> @Override -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L184" href="#L184">184</a> finish(); -<a class="jxr_linenumber" name="L185" href="#L185">185</a> out.close(); -<a class="jxr_linenumber" name="L186" href="#L186">186</a> } -<a class="jxr_linenumber" name="L187" href="#L187">187</a> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * Compresses all remaining data and writes it to the stream,</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * doesn't close the underlying stream.</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @throws IOException if an error occurs</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> finish() <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">if</strong> (!finished) { -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">if</strong> (currentIndex > 0) { -<a class="jxr_linenumber" name="L196" href="#L196">196</a> flushBlock(); -<a class="jxr_linenumber" name="L197" href="#L197">197</a> } -<a class="jxr_linenumber" name="L198" href="#L198">198</a> writeTrailer(); -<a class="jxr_linenumber" name="L199" href="#L199">199</a> finished = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L200" href="#L200">200</a> } -<a class="jxr_linenumber" name="L201" href="#L201">201</a> } -<a class="jxr_linenumber" name="L202" href="#L202">202</a> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeFrameDescriptor() <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">int</strong> flags = FramedLZ4CompressorInputStream.SUPPORTED_VERSION -<a class="jxr_linenumber" name="L205" href="#L205">205</a> | FramedLZ4CompressorInputStream.BLOCK_INDEPENDENCE_MASK; -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">if</strong> (params.withContentChecksum) { -<a class="jxr_linenumber" name="L207" href="#L207">207</a> flags |= FramedLZ4CompressorInputStream.CONTENT_CHECKSUM_MASK; -<a class="jxr_linenumber" name="L208" href="#L208">208</a> } -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { -<a class="jxr_linenumber" name="L210" href="#L210">210</a> flags |= FramedLZ4CompressorInputStream.BLOCK_CHECKSUM_MASK; -<a class="jxr_linenumber" name="L211" href="#L211">211</a> } -<a class="jxr_linenumber" name="L212" href="#L212">212</a> out.write(flags); -<a class="jxr_linenumber" name="L213" href="#L213">213</a> contentHash.update(flags); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">int</strong> bd = params.blockSize.getIndex() << 4; -<a class="jxr_linenumber" name="L215" href="#L215">215</a> out.write(bd); -<a class="jxr_linenumber" name="L216" href="#L216">216</a> contentHash.update(bd); -<a class="jxr_linenumber" name="L217" href="#L217">217</a> out.write((<strong class="jxr_keyword">int</strong>) ((contentHash.getValue() >> 8) & 0xff)); -<a class="jxr_linenumber" name="L218" href="#L218">218</a> contentHash.reset(); -<a class="jxr_linenumber" name="L219" href="#L219">219</a> } -<a class="jxr_linenumber" name="L220" href="#L220">220</a> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> flushBlock() <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L222" href="#L222">222</a> ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream(); -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">try</strong> (OutputStream o = <strong class="jxr_keyword">new</strong> BlockLZ4CompressorOutputStream(baos)) { -<a class="jxr_linenumber" name="L224" href="#L224">224</a> o.write(blockData, 0, currentIndex); -<a class="jxr_linenumber" name="L225" href="#L225">225</a> } -<a class="jxr_linenumber" name="L226" href="#L226">226</a> byte[] b = baos.toByteArray(); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> (b.length > currentIndex) { <em class="jxr_comment">// compression increased size, maybe beyond blocksize</em> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> ByteUtils.toLittleEndian(out, currentIndex | FramedLZ4CompressorInputStream.UNCOMPRESSED_FLAG_MASK, -<a class="jxr_linenumber" name="L229" href="#L229">229</a> 4); -<a class="jxr_linenumber" name="L230" href="#L230">230</a> out.write(blockData, 0, currentIndex); -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { -<a class="jxr_linenumber" name="L232" href="#L232">232</a> blockHash.update(blockData, 0, currentIndex); -<a class="jxr_linenumber" name="L233" href="#L233">233</a> } -<a class="jxr_linenumber" name="L234" href="#L234">234</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L235" href="#L235">235</a> ByteUtils.toLittleEndian(out, b.length, 4); -<a class="jxr_linenumber" name="L236" href="#L236">236</a> out.write(b); -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { -<a class="jxr_linenumber" name="L238" href="#L238">238</a> blockHash.update(b, 0, b.length); -<a class="jxr_linenumber" name="L239" href="#L239">239</a> } -<a class="jxr_linenumber" name="L240" href="#L240">240</a> } -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { -<a class="jxr_linenumber" name="L242" href="#L242">242</a> ByteUtils.toLittleEndian(out, blockHash.getValue(), 4); -<a class="jxr_linenumber" name="L243" href="#L243">243</a> blockHash.reset(); -<a class="jxr_linenumber" name="L244" href="#L244">244</a> } -<a class="jxr_linenumber" name="L245" href="#L245">245</a> currentIndex = 0; -<a class="jxr_linenumber" name="L246" href="#L246">246</a> } -<a class="jxr_linenumber" name="L247" href="#L247">247</a> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeTrailer() <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L249" href="#L249">249</a> out.write(END_MARK); -<a class="jxr_linenumber" name="L250" href="#L250">250</a> ByteUtils.toLittleEndian(out, contentHash.getValue(), 4); -<a class="jxr_linenumber" name="L251" href="#L251">251</a> } +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_comment">// used in one-arg write method</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> byte[] oneByte = <strong class="jxr_keyword">new</strong> byte[1]; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> byte[] blockData; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> OutputStream out; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> params; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> finished = false; +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> currentIndex = 0; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_comment">// used for frame header checksum and content checksum, if requested</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a> contentHash = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a>(); +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_comment">// used for block checksum, if requested</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a> blockHash; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * The block sizes supported by the format.</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> { +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/** Block size of 64K */</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> K64(64 * 1024, 0), +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/** Block size of 256K */</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> K256(256 * 1024, 1), +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/** Block size of 1M */</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> M1(1024 * 1024, 2), +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/** Block size of 4M */</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> M4(1024 * 1024, 4); +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> size, index; +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a>(<strong class="jxr_keyword">int</strong> size, <strong class="jxr_keyword">int</strong> index) { +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">this</strong>.size = size; +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">this</strong>.index = index; +<a class="jxr_linenumber" name="L77" href="#L77">77</a> } +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">int</strong> getSize() { +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">return</strong> size; +<a class="jxr_linenumber" name="L80" href="#L80">80</a> } +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">int</strong> getIndex() { +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">return</strong> index; +<a class="jxr_linenumber" name="L83" href="#L83">83</a> } +<a class="jxr_linenumber" name="L84" href="#L84">84</a> } +<a class="jxr_linenumber" name="L85" href="#L85">85</a> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * Parameters of the LZ4 frame format.</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> { +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> blockSize; +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> withContentChecksum, withBlockChecksum; +<a class="jxr_linenumber" name="L92" href="#L92">92</a> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * The default parameters of 4M block size, enabled content</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * checksum, disabled block checksums and independent blocks.</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * <p>This matches the defaults of the lz4 command line utility.</p></em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> DEFAULT = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a>(BlockSize.M4, <strong class="jxr_keyword">true</strong>, false); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * Sets up custom a custom block size for the LZ4 stream but</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * otherwise uses the defaults of enabled content checksum,</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * disabled block checksums and independent blocks.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @param blockSize the size of a single block.</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a>(<a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> blockSize) { +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">this</strong>(blockSize, <strong class="jxr_keyword">true</strong>, false); +<a class="jxr_linenumber" name="L109" href="#L109">109</a> } +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * Sets up custom parameters for the LZ4 stream.</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @param blockSize the size of a single block.</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @param withContentChecksum whether to write a content checksum</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @param withBlockChecksum whether to write a block checksum.</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * Note that block checksums are not supported by the lz4</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * command line utility</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a>(<a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">BlockSize</a> blockSize, <strong class="jxr_keyword">boolean</strong> withContentChecksum, <strong class="jxr_keyword">boolean</strong> withBlockChecksum) { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">this</strong>.blockSize = blockSize; +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">this</strong>.withContentChecksum = withContentChecksum; +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">this</strong>.withBlockChecksum = withBlockChecksum; +<a class="jxr_linenumber" name="L122" href="#L122">122</a> } +<a class="jxr_linenumber" name="L123" href="#L123">123</a> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> @Override +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">public</strong> String toString() { +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"LZ4 Parameters with BlockSize "</span> + blockSize + <span class="jxr_string">", withContentChecksum "</span> + withContentChecksum +<a class="jxr_linenumber" name="L127" href="#L127">127</a> + <span class="jxr_string">", withBlockChecksum "</span> + withBlockChecksum; +<a class="jxr_linenumber" name="L128" href="#L128">128</a> } +<a class="jxr_linenumber" name="L129" href="#L129">129</a> } +<a class="jxr_linenumber" name="L130" href="#L130">130</a> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * Constructs a new output stream that compresses data using the</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * LZ4 frame format using the default block size of 4MB.</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @param out the OutputStream to which to write the compressed data</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @throws IOException if writing the signature fails</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">FramedLZ4CompressorOutputStream</a>(OutputStream out) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">this</strong>(out, Parameters.DEFAULT); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> } +<a class="jxr_linenumber" name="L140" href="#L140">140</a> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Constructs a new output stream that compresses data using the</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * LZ4 frame format using the given block size.</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * @param out the OutputStream to which to write the compressed data</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * @param params the parameters to use</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @throws IOException if writing the signature fails</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">FramedLZ4CompressorOutputStream</a>(OutputStream out, <a href="../../../../../../org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorOutputStream.html">Parameters</a> params) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">this</strong>.params = params; +<a class="jxr_linenumber" name="L150" href="#L150">150</a> blockData = <strong class="jxr_keyword">new</strong> byte[params.blockSize.getSize()]; +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">this</strong>.out = out; +<a class="jxr_linenumber" name="L152" href="#L152">152</a> blockHash = params.withBlockChecksum ? <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/lz4/XXHash32.html">XXHash32</a>() : <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L153" href="#L153">153</a> out.write(FramedLZ4CompressorInputStream.LZ4_SIGNATURE); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> writeFrameDescriptor(); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> } +<a class="jxr_linenumber" name="L156" href="#L156">156</a> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> @Override +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(<strong class="jxr_keyword">int</strong> b) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L159" href="#L159">159</a> oneByte[0] = (byte) (b & 0xff); +<a class="jxr_linenumber" name="L160" href="#L160">160</a> write(oneByte); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> } +<a class="jxr_linenumber" name="L162" href="#L162">162</a> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> @Override +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(byte[] data, <strong class="jxr_keyword">int</strong> off, <strong class="jxr_keyword">int</strong> len) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L165" href="#L165">165</a> contentHash.update(data, off, len); +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">if</strong> (currentIndex + len > blockData.length) { +<a class="jxr_linenumber" name="L167" href="#L167">167</a> flushBlock(); +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">while</strong> (len > blockData.length) { +<a class="jxr_linenumber" name="L169" href="#L169">169</a> System.arraycopy(data, off, blockData, 0, blockData.length); +<a class="jxr_linenumber" name="L170" href="#L170">170</a> off += blockData.length; +<a class="jxr_linenumber" name="L171" href="#L171">171</a> len -= blockData.length; +<a class="jxr_linenumber" name="L172" href="#L172">172</a> currentIndex = blockData.length; +<a class="jxr_linenumber" name="L173" href="#L173">173</a> flushBlock(); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> } +<a class="jxr_linenumber" name="L175" href="#L175">175</a> } +<a class="jxr_linenumber" name="L176" href="#L176">176</a> System.arraycopy(data, off, blockData, currentIndex, len); +<a class="jxr_linenumber" name="L177" href="#L177">177</a> currentIndex += len; +<a class="jxr_linenumber" name="L178" href="#L178">178</a> } +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> @Override +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L182" href="#L182">182</a> finish(); +<a class="jxr_linenumber" name="L183" href="#L183">183</a> out.close(); +<a class="jxr_linenumber" name="L184" href="#L184">184</a> } +<a class="jxr_linenumber" name="L185" href="#L185">185</a> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * Compresses all remaining data and writes it to the stream,</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * doesn't close the underlying stream.</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @throws IOException if an error occurs</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> finish() <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (!finished) { +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> (currentIndex > 0) { +<a class="jxr_linenumber" name="L194" href="#L194">194</a> flushBlock(); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> } +<a class="jxr_linenumber" name="L196" href="#L196">196</a> writeTrailer(); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> finished = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L198" href="#L198">198</a> } +<a class="jxr_linenumber" name="L199" href="#L199">199</a> } +<a class="jxr_linenumber" name="L200" href="#L200">200</a> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeFrameDescriptor() <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">int</strong> flags = FramedLZ4CompressorInputStream.SUPPORTED_VERSION +<a class="jxr_linenumber" name="L203" href="#L203">203</a> | FramedLZ4CompressorInputStream.BLOCK_INDEPENDENCE_MASK; +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">if</strong> (params.withContentChecksum) { +<a class="jxr_linenumber" name="L205" href="#L205">205</a> flags |= FramedLZ4CompressorInputStream.CONTENT_CHECKSUM_MASK; +<a class="jxr_linenumber" name="L206" href="#L206">206</a> } +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { +<a class="jxr_linenumber" name="L208" href="#L208">208</a> flags |= FramedLZ4CompressorInputStream.BLOCK_CHECKSUM_MASK; +<a class="jxr_linenumber" name="L209" href="#L209">209</a> } +<a class="jxr_linenumber" name="L210" href="#L210">210</a> out.write(flags); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> contentHash.update(flags); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">int</strong> bd = params.blockSize.getIndex() << 4; +<a class="jxr_linenumber" name="L213" href="#L213">213</a> out.write(bd); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> contentHash.update(bd); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> out.write((<strong class="jxr_keyword">int</strong>) ((contentHash.getValue() >> 8) & 0xff)); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> contentHash.reset(); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> } +<a class="jxr_linenumber" name="L218" href="#L218">218</a> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> flushBlock() <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L220" href="#L220">220</a> ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream(); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">try</strong> (OutputStream o = <strong class="jxr_keyword">new</strong> BlockLZ4CompressorOutputStream(baos)) { +<a class="jxr_linenumber" name="L222" href="#L222">222</a> o.write(blockData, 0, currentIndex); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> } +<a class="jxr_linenumber" name="L224" href="#L224">224</a> byte[] b = baos.toByteArray(); +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">if</strong> (b.length > currentIndex) { <em class="jxr_comment">// compression increased size, maybe beyond blocksize</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> ByteUtils.toLittleEndian(out, currentIndex | FramedLZ4CompressorInputStream.UNCOMPRESSED_FLAG_MASK, +<a class="jxr_linenumber" name="L227" href="#L227">227</a> 4); +<a class="jxr_linenumber" name="L228" href="#L228">228</a> out.write(blockData, 0, currentIndex); +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { +<a class="jxr_linenumber" name="L230" href="#L230">230</a> blockHash.update(blockData, 0, currentIndex); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> } +<a class="jxr_linenumber" name="L232" href="#L232">232</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L233" href="#L233">233</a> ByteUtils.toLittleEndian(out, b.length, 4); +<a class="jxr_linenumber" name="L234" href="#L234">234</a> out.write(b); +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { +<a class="jxr_linenumber" name="L236" href="#L236">236</a> blockHash.update(b, 0, b.length); +<a class="jxr_linenumber" name="L237" href="#L237">237</a> } +<a class="jxr_linenumber" name="L238" href="#L238">238</a> } +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">if</strong> (params.withBlockChecksum) { +<a class="jxr_linenumber" name="L240" href="#L240">240</a> ByteUtils.toLittleEndian(out, blockHash.getValue(), 4); +<a class="jxr_linenumber" name="L241" href="#L241">241</a> blockHash.reset(); +<a class="jxr_linenumber" name="L242" href="#L242">242</a> } +<a class="jxr_linenumber" name="L243" href="#L243">243</a> currentIndex = 0; +<a class="jxr_linenumber" name="L244" href="#L244">244</a> } +<a class="jxr_linenumber" name="L245" href="#L245">245</a> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeTrailer() <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L247" href="#L247">247</a> out.write(END_MARK); +<a class="jxr_linenumber" name="L248" href="#L248">248</a> ByteUtils.toLittleEndian(out, contentHash.getValue(), 4); +<a class="jxr_linenumber" name="L249" href="#L249">249</a> } +<a class="jxr_linenumber" name="L250" href="#L250">250</a> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> } <a class="jxr_linenumber" name="L252" href="#L252">252</a> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> } -<a class="jxr_linenumber" name="L254" href="#L254">254</a> </pre> <hr/> <div id="footer">Copyright © 2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>