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.util.ArrayList;
46  import java.util.List;
47  
48  import org.eclipse.jgit.api.ArchiveCommand;
49  
50  /**
51   * Registers all format types from the org.eclipse.jgit.archive package for use
52   * via the ArchiveCommand API.
53   *
54   * See {@link org.eclipse.jgit.archive.FormatActivator} for an OSGi bundle
55   * activator that performs the same registration automatically.
56   */
57  public class ArchiveFormats {
58  	private static final List<String> myFormats = new ArrayList<>();
59  
60  	private static final void register(String name, ArchiveCommand.Format<?> fmt) {
61  		myFormats.add(name);
62  		ArchiveCommand.registerFormat(name, fmt);
63  	}
64  
65  	/**
66  	 * Register all included archive formats so they can be used
67  	 * as arguments to the ArchiveCommand.setFormat() method.
68  	 *
69  	 * Not thread-safe.
70  	 */
71  	public static void registerAll() {
72  		register("tar", new TarFormat()); //$NON-NLS-1$
73  		register("tgz", new TgzFormat()); //$NON-NLS-1$
74  		register("tbz2", new Tbz2Format()); //$NON-NLS-1$
75  		register("txz", new TxzFormat()); //$NON-NLS-1$
76  		register("zip", new ZipFormat()); //$NON-NLS-1$
77  	}
78  
79  	/**
80  	 * Clean up by deregistering all formats that were registered
81  	 * by registerAll().
82  	 *
83  	 * Not thread-safe.
84  	 */
85  	public static void unregisterAll() {
86  		for (String name : myFormats) {
87  			ArchiveCommand.unregisterFormat(name);
88  		}
89  		myFormats.clear();
90  	}
91  }