You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2014/08/31 21:27:54 UTC
svn commit: r920865 [45/45] - in
/websites/production/commons/content/proper/commons-compress: ./ apidocs/
apidocs/org/apache/commons/compress/archivers/
apidocs/org/apache/commons/compress/archivers/ar/
apidocs/org/apache/commons/compress/archivers/ar...
Modified: websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/XZUtils.html
==============================================================================
--- websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/XZUtils.html (original)
+++ websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/XZUtils.html Sun Aug 31 19:27:46 2014
@@ -28,86 +28,164 @@
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map;
-<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.compressors.FileNameUtil;
-<a class="jxr_linenumber" name="L24" href="#L24">24</a>
-<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Utility code for the xz compression format.</em>
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * @ThreadSafe</em>
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * @since 1.4</em>
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">XZUtils</a> {
-<a class="jxr_linenumber" name="L31" href="#L31">31</a>
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/FileNameUtil.html">FileNameUtil</a> fileNameUtil;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">static</strong> {
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> Map<String, String> uncompressSuffix = <strong class="jxr_keyword">new</strong> HashMap<String, String>();
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> uncompressSuffix.put(<span class="jxr_string">".txz"</span>, <span class="jxr_string">".tar"</span>);
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> uncompressSuffix.put(<span class="jxr_string">".xz"</span>, <span class="jxr_string">""</span>);
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> uncompressSuffix.put(<span class="jxr_string">"-xz"</span>, <span class="jxr_string">""</span>);
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> fileNameUtil = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/FileNameUtil.html">FileNameUtil</a>(uncompressSuffix, <span class="jxr_string">".xz"</span>);
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> }
-<a class="jxr_linenumber" name="L41" href="#L41">41</a>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/** Private constructor to prevent instantiation of this utility class. */</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">XZUtils</a>() {
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> }
-<a class="jxr_linenumber" name="L45" href="#L45">45</a>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Are the classes required to support XZ compression available?</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @since 1.5</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isXZCompressionAvailable() {
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">try</strong> {
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> XZCompressorInputStream.matches(<strong class="jxr_keyword">null</strong>, 0);
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> } <strong class="jxr_keyword">catch</strong> (NoClassDefFoundError error) {
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">return</strong> false;
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> }
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
-<a class="jxr_linenumber" name="L58" href="#L58">58</a>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Detects common xz suffixes in the given filename.</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @param filename name of a file</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @return {@code true} if the filename has a common xz suffix,</em>
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * {@code false} otherwise</em>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isCompressedFilename(String filename) {
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">return</strong> fileNameUtil.isCompressedFilename(filename);
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
-<a class="jxr_linenumber" name="L69" href="#L69">69</a>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Maps the given name of a xz-compressed file to the name that the</em>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * file should have after uncompression. Commonly used file type specific</em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * suffixes like ".txz" are automatically detected and</em>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * correctly mapped. For example the name "package.txz" is mapped to</em>
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * "package.tar". And any filenames with the generic ".xz" suffix</em>
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * (or any other generic xz suffix) is mapped to a name without that</em>
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * suffix. If no xz suffix is detected, then the filename is returned</em>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * unmapped.</em>
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @param filename name of a file</em>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @return name of the corresponding uncompressed file</em>
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getUncompressedFilename(String filename) {
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> fileNameUtil.getUncompressedFilename(filename);
-<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> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Maps the given filename to the name that the file should have after</em>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * compression with xz. Common file types with custom suffixes for</em>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * compressed versions are automatically detected and correctly mapped.</em>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * For example the name "package.tar" is mapped to "package.txz". If no</em>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * custom mapping is applicable, then the default ".xz" suffix is appended</em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * to the filename.</em>
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param filename name of a file</em>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @return name of the corresponding compressed file</em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getCompressedFilename(String filename) {
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">return</strong> fileNameUtil.getCompressedFilename(filename);
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
-<a class="jxr_linenumber" name="L101" href="#L101">101</a>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.atomic.AtomicInteger;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.compressors.FileNameUtil;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a>
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * Utility code for the xz compression format.</em>
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * @ThreadSafe</em>
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * @since 1.4</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">XZUtils</a> {
+<a class="jxr_linenumber" name="L32" href="#L32">32</a>
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/FileNameUtil.html">FileNameUtil</a> fileNameUtil;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * XZ Header Magic Bytes begin a XZ file.</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <p>This is a copy of {@code org.tukaani.xz.XZ.HEADER_MAGIC} in</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * XZ for Java version 1.5.</p></em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] HEADER_MAGIC = {
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> (byte) 0xFD, '7', 'z', 'X', 'Z', '\0'
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> };
+<a class="jxr_linenumber" name="L44" href="#L44">44</a>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">static</strong> enum <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">CachedAvailability</a> {
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> DONT_CACHE, CACHED_AVAILABLE, CACHED_UNAVAILABLE
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> }
+<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">static</strong> <strong class="jxr_keyword">volatile</strong> <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">CachedAvailability</a> cachedXZAvailability;
+<a class="jxr_linenumber" name="L50" href="#L50">50</a>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">static</strong> {
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> Map<String, String> uncompressSuffix = <strong class="jxr_keyword">new</strong> HashMap<String, String>();
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> uncompressSuffix.put(<span class="jxr_string">".txz"</span>, <span class="jxr_string">".tar"</span>);
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> uncompressSuffix.put(<span class="jxr_string">".xz"</span>, <span class="jxr_string">""</span>);
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> uncompressSuffix.put(<span class="jxr_string">"-xz"</span>, <span class="jxr_string">""</span>);
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> fileNameUtil = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/compress/compressors/FileNameUtil.html">FileNameUtil</a>(uncompressSuffix, <span class="jxr_string">".xz"</span>);
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> cachedXZAvailability = CachedAvailability.DONT_CACHE;
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> Class.forName(<span class="jxr_string">"org.osgi.framework.BundleEvent"</span>);
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> setCacheXZAvailablity(<strong class="jxr_keyword">true</strong>);
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> }
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> }
+<a class="jxr_linenumber" name="L64" href="#L64">64</a>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/** Private constructor to prevent instantiation of this utility class. */</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">XZUtils</a>() {
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
+<a class="jxr_linenumber" name="L68" href="#L68">68</a>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Checks if the signature matches what is expected for a .xz file.</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <p>This is more or less a copy of the version found in {@link</em>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * XZCompressorInputStream} but doesn't depend on the presence of</em>
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * XZ for Java.</p></em>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @param signature the bytes to check</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @param length the number of bytes to check</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @return true if signature matches the .xz magic bytes, false otherwise</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @since 1.9</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> matches(byte[] signature, <strong class="jxr_keyword">int</strong> length) {
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> (length < HEADER_MAGIC.length) {
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">return</strong> false;
+<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> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < HEADER_MAGIC.length; ++i) {
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">if</strong> (signature[i] != HEADER_MAGIC[i]) {
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
+<a class="jxr_linenumber" name="L91" href="#L91">91</a>
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
+<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"> * Are the classes required to support XZ compression available?</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @since 1.5</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">boolean</strong> isXZCompressionAvailable() {
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">CachedAvailability</a> cachedResult = cachedXZAvailability;
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">if</strong> (cachedResult != CachedAvailability.DONT_CACHE) {
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">return</strong> cachedResult == CachedAvailability.CACHED_AVAILABLE;
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">return</strong> internalIsXZCompressionAvailable();
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
+<a class="jxr_linenumber" name="L106" href="#L106">106</a>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> internalIsXZCompressionAvailable() {
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> XZCompressorInputStream.matches(<strong class="jxr_keyword">null</strong>, 0);
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> } <strong class="jxr_keyword">catch</strong> (NoClassDefFoundError error) {
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
+<a class="jxr_linenumber" name="L115" href="#L115">115</a>
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Detects common xz suffixes in the given filename.</em>
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @param filename name of a file</em>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @return {@code true} if the filename has a common xz suffix,</em>
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * {@code false} otherwise</em>
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isCompressedFilename(String filename) {
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> fileNameUtil.isCompressedFilename(filename);
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
+<a class="jxr_linenumber" name="L126" href="#L126">126</a>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * Maps the given name of a xz-compressed file to the name that the</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * file should have after uncompression. Commonly used file type specific</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * suffixes like ".txz" are automatically detected and</em>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * correctly mapped. For example the name "package.txz" is mapped to</em>
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * "package.tar". And any filenames with the generic ".xz" suffix</em>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * (or any other generic xz suffix) is mapped to a name without that</em>
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * suffix. If no xz suffix is detected, then the filename is returned</em>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * unmapped.</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> <em class="jxr_javadoccomment"> * @param filename name of a file</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @return name of the corresponding uncompressed file</em>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getUncompressedFilename(String filename) {
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">return</strong> fileNameUtil.getUncompressedFilename(filename);
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> }
+<a class="jxr_linenumber" name="L143" href="#L143">143</a>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * Maps the given filename to the name that the file should have after</em>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * compression with xz. Common file types with custom suffixes for</em>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * compressed versions are automatically detected and correctly mapped.</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * For example the name "package.tar" is mapped to "package.txz". If no</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * custom mapping is applicable, then the default ".xz" suffix is appended</em>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * to the filename.</em>
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @param filename name of a file</em>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @return name of the corresponding compressed file</em>
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getCompressedFilename(String filename) {
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> fileNameUtil.getCompressedFilename(filename);
+<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> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Whether to cache the result of the XZ for Java check.</em>
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * <p>This defaults to {@code false} in an OSGi environment and {@code true} otherwise.</p></em>
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @param doCache whether to cache the result</em>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @since 1.9</em>
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setCacheXZAvailablity(<strong class="jxr_keyword">boolean</strong> doCache) {
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">if</strong> (!doCache) {
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> cachedXZAvailability = CachedAvailability.DONT_CACHE;
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (cachedXZAvailability == CachedAvailability.DONT_CACHE) {
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> hasXz = internalIsXZCompressionAvailable();
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> cachedXZAvailability = hasXz ? CachedAvailability.CACHED_AVAILABLE
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> : CachedAvailability.CACHED_UNAVAILABLE;
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> }
+<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> <em class="jxr_comment">// only exists to support unit tests</em>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/commons/compress/compressors/xz/XZUtils.html">CachedAvailability</a> getCachedXZAvailability() {
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> cachedXZAvailability;
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/package-frame.html
==============================================================================
--- websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/package-frame.html (original)
+++ websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/package-frame.html Sun Aug 31 19:27:46 2014
@@ -16,6 +16,9 @@
<ul>
<li>
+ <a href="XZUtils.html" target="classFrame">CachedAvailability</a>
+ </li>
+ <li>
<a href="XZCompressorInputStream.html" target="classFrame">XZCompressorInputStream</a>
</li>
<li>
Modified: websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/package-summary.html
==============================================================================
--- websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/package-summary.html (original)
+++ websites/production/commons/content/proper/commons-compress/xref/org/apache/commons/compress/compressors/xz/package-summary.html Sun Aug 31 19:27:46 2014
@@ -37,6 +37,11 @@
<tbody>
<tr>
<td>
+ <a href="XZUtils.html" target="classFrame">CachedAvailability</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
<a href="XZCompressorInputStream.html" target="classFrame">XZCompressorInputStream</a>
</td>
</tr>
Modified: websites/production/commons/content/proper/commons-compress/zip.html
==============================================================================
--- websites/production/commons/content/proper/commons-compress/zip.html (original)
+++ websites/production/commons/content/proper/commons-compress/zip.html Sun Aug 31 19:27:46 2014
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 12 July 2014
+ | Generated by Apache Maven Doxia at 31 August 2014
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -8,7 +8,7 @@
<meta charset="iso-8859-1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20140712" />
+ <meta name="Date-Revision-yyyymmdd" content="20140831" />
<meta http-equiv="Content-Language" content="en" />
<title>Commons Compress -
Commons Compress ZIP package</title>
@@ -45,7 +45,7 @@
<a class="brand" href="http://commons.apache.org/proper/commons-compress/">Apache Commons Compress ™</a>
<ul class="nav">
- <li id="publishDate">Last Published: 12 July 2014</li>
+ <li id="publishDate">Last Published: 31 August 2014</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.9-SNAPSHOT</li>
</ul>
<div class="pull-right"> <ul class="nav">