View Javadoc
1   /*
2    * Copyright (C) 2008, Google Inc.
3    * Copyright (C) 2006-2008, Shawn O. Pearce <spearce@spearce.org>
4    * and other copyright owners as documented in the project's IP log.
5    *
6    * This program and the accompanying materials are made available
7    * under the terms of the Eclipse Distribution License v1.0 which
8    * accompanies this distribution, is reproduced below, and is
9    * available at http://www.eclipse.org/org/documents/edl-v10.php
10   *
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or
14   * without modification, are permitted provided that the following
15   * conditions are met:
16   *
17   * - Redistributions of source code must retain the above copyright
18   *   notice, this list of conditions and the following disclaimer.
19   *
20   * - Redistributions in binary form must reproduce the above
21   *   copyright notice, this list of conditions and the following
22   *   disclaimer in the documentation and/or other materials provided
23   *   with the distribution.
24   *
25   * - Neither the name of the Eclipse Foundation, Inc. nor the
26   *   names of its contributors may be used to endorse or promote
27   *   products derived from this software without specific prior
28   *   written permission.
29   *
30   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43   */
44  
45  package org.eclipse.jgit.lib;
46  
47  import java.util.zip.Inflater;
48  
49  /**
50   * Creates zlib based inflaters as necessary for object decompression.
51   */
52  public class InflaterCache {
53  	private static final int SZ = 4;
54  
55  	private static final Inflater[] inflaterCache;
56  
57  	private static int openInflaterCount;
58  
59  	static {
60  		inflaterCache = new Inflater[SZ];
61  	}
62  
63  	/**
64  	 * Obtain an Inflater for decompression.
65  	 * <p>
66  	 * Inflaters obtained through this cache should be returned (if possible) by
67  	 * {@link #release(Inflater)} to avoid garbage collection and reallocation.
68  	 *
69  	 * @return an available inflater. Never null.
70  	 */
71  	public static Inflater get() {
72  		final Inflater r = getImpl();
73  		return r != null ? r : new Inflater(false);
74  	}
75  
76  	private synchronized static Inflater getImpl() {
77  		if (openInflaterCount > 0) {
78  			final Inflater r = inflaterCache[--openInflaterCount];
79  			inflaterCache[openInflaterCount] = null;
80  			return r;
81  		}
82  		return null;
83  	}
84  
85  	/**
86  	 * Release an inflater previously obtained from this cache.
87  	 *
88  	 * @param i
89  	 *            the inflater to return. May be null, in which case this method
90  	 *            does nothing.
91  	 */
92  	public static void release(Inflater i) {
93  		if (i != null) {
94  			i.reset();
95  			if (releaseImpl(i))
96  				i.end();
97  		}
98  	}
99  
100 	private static synchronized boolean releaseImpl(Inflater i) {
101 		if (openInflaterCount < SZ) {
102 			inflaterCache[openInflaterCount++] = i;
103 			return false;
104 		}
105 		return true;
106 	}
107 
108 	private InflaterCache() {
109 		throw new UnsupportedOperationException();
110 	}
111 }