View Javadoc
1   /*
2    * Copyright (C) 2013 Google Inc.
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  package org.eclipse.jgit.archive;
44  
45  import java.io.IOException;
46  import java.io.OutputStream;
47  import java.util.Arrays;
48  import java.util.Collections;
49  import java.util.List;
50  import java.util.Map;
51  
52  import org.apache.commons.compress.archivers.ArchiveOutputStream;
53  import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream;
54  import org.eclipse.jgit.api.ArchiveCommand;
55  import org.eclipse.jgit.lib.FileMode;
56  import org.eclipse.jgit.lib.ObjectId;
57  import org.eclipse.jgit.lib.ObjectLoader;
58  
59  /**
60   * gzip-compressed tarball (tar.gz) format.
61   */
62  public final class TgzFormat extends BaseFormat implements
63  		ArchiveCommand.Format<ArchiveOutputStream> {
64  	private static final List<String> SUFFIXES = Collections
65  			.unmodifiableList(Arrays.asList(".tar.gz", ".tgz")); //$NON-NLS-1$ //$NON-NLS-2$
66  
67  	private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat();
68  
69  	@Override
70  	public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
71  			throws IOException {
72  		return createArchiveOutputStream(s,
73  				Collections.<String, Object> emptyMap());
74  	}
75  
76  	/**
77  	 * @since 4.0
78  	 */
79  	@Override
80  	public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
81  			Map<String, Object> o) throws IOException {
82  		GzipCompressorOutputStream out = new GzipCompressorOutputStream(s);
83  		return tarFormat.createArchiveOutputStream(out, o);
84  	}
85  
86  	@Deprecated
87  	@Override
88  	public void putEntry(ArchiveOutputStream out,
89  			String path, FileMode mode, ObjectLoader loader)
90  			throws IOException {
91  		putEntry(out, null, path, mode,loader);
92  	}
93  
94  	/**
95  	 * @since 4.7
96  	 */
97  	@Override
98  	public void putEntry(ArchiveOutputStream out,
99  			ObjectId tree, String path, FileMode mode, ObjectLoader loader)
100 			throws IOException {
101 		tarFormat.putEntry(out, tree, path, mode, loader);
102 	}
103 
104 	@Override
105 	public Iterable<String> suffixes() {
106 		return SUFFIXES;
107 	}
108 
109 	@Override
110 	public boolean equals(Object other) {
111 		return (other instanceof TgzFormat);
112 	}
113 
114 	@Override
115 	public int hashCode() {
116 		return getClass().hashCode();
117 	}
118 }