View Javadoc
1   package nom.tam.fits.compress;
2   
3   /*
4    * #%L
5    * nom.tam FITS library
6    * %%
7    * Copyright (C) 1996 - 2024 nom-tam-fits
8    * %%
9    * This is free and unencumbered software released into the public domain.
10   *
11   * Anyone is free to copy, modify, publish, use, compile, sell, or
12   * distribute this software, either in source code form or as a compiled
13   * binary, for any purpose, commercial or non-commercial, and by any
14   * means.
15   *
16   * In jurisdictions that recognize copyright laws, the author or authors
17   * of this software dedicate any and all copyright interest in the
18   * software to the public domain. We make this dedication for the benefit
19   * of the public at large and to the detriment of our heirs and
20   * successors. We intend this dedication to be an overt act of
21   * relinquishment in perpetuity of all present and future rights to this
22   * software under copyright law.
23   *
24   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27   * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28   * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29   * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30   * OTHER DEALINGS IN THE SOFTWARE.
31   * #L%
32   */
33  
34  import java.io.IOException;
35  import java.io.InputStream;
36  
37  /**
38   * (<i>for internal use</i>) BZIP2 (<code>.bz2</code>) input stream decompression. You can use this class to decompress
39   * files that have been compressed with <code>bzip2</code>, or use {@link CompressionManager} to automatically detect
40   * the type of compression used. This class uses the Apache <b>commons-compress</b> package to perform the
41   * decompression.
42   * 
43   * @see CompressionManager
44   */
45  public class BZip2CompressionProvider implements ICompressProvider {
46  
47      private static final int PRIORITY = 5;
48  
49      @SuppressWarnings("deprecation")
50      @Override
51      public InputStream decompress(InputStream in) throws IOException {
52          try {
53              return CompressionLibLoaderProtection.createBZip2Stream(in);
54          } catch (IOException e) {
55              throw e;
56          } catch (Exception e) {
57              throw new IOException(e);
58          }
59      }
60  
61      @Override
62      public int priority() {
63          return PRIORITY;
64      }
65  
66      @Override
67      public boolean provides(int mag1, int mag2) {
68          return mag1 == 'B' && mag2 == 'Z';
69      }
70  }