View Javadoc
1   /*
2    * Copyright (C) 2012, 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  
44  package org.eclipse.jgit.transport;
45  
46  import java.util.List;
47  
48  /**
49   * {@link org.eclipse.jgit.transport.AdvertiseRefsHook} that delegates to a list
50   * of other hooks.
51   * <p>
52   * Hooks are run in the order passed to the constructor. A hook may inspect or
53   * modify the results of the previous hooks in the chain by calling
54   * {@link org.eclipse.jgit.transport.UploadPack#getAdvertisedRefs()}, or
55   * {@link org.eclipse.jgit.transport.BaseReceivePack#getAdvertisedRefs()} or
56   * {@link org.eclipse.jgit.transport.BaseReceivePack#getAdvertisedObjects()}.
57   */
58  public class AdvertiseRefsHookChain implements AdvertiseRefsHook {
59  	private final AdvertiseRefsHook[] hooks;
60  	private final int count;
61  
62  	/**
63  	 * Create a new hook chaining the given hooks together.
64  	 *
65  	 * @param hooks
66  	 *            hooks to execute, in order.
67  	 * @return a new hook chain of the given hooks.
68  	 */
69  	public static AdvertiseRefsHook newChain(List<? extends AdvertiseRefsHook> hooks) {
70  		AdvertiseRefsHook[] newHooks = new AdvertiseRefsHook[hooks.size()];
71  		int i = 0;
72  		for (AdvertiseRefsHook hook : hooks)
73  			if (hook != AdvertiseRefsHook.DEFAULT)
74  				newHooks[i++] = hook;
75  		if (i == 0)
76  			return AdvertiseRefsHook.DEFAULT;
77  		else if (i == 1)
78  			return newHooks[0];
79  		else
80  			return new AdvertiseRefsHookChain(newHooks, i);
81  	}
82  
83  	/** {@inheritDoc} */
84  	@Override
85  	public void advertiseRefs(BaseReceivePack rp)
86  			throws ServiceMayNotContinueException {
87  		for (int i = 0; i < count; i++)
88  			hooks[i].advertiseRefs(rp);
89  	}
90  
91  	/** {@inheritDoc} */
92  	@Override
93  	public void advertiseRefs(UploadPack rp)
94  			throws ServiceMayNotContinueException {
95  		for (int i = 0; i < count; i++)
96  			hooks[i].advertiseRefs(rp);
97  	}
98  
99  	private AdvertiseRefsHookChain(AdvertiseRefsHook[] hooks, int count) {
100 		this.hooks = hooks;
101 		this.count = count;
102 	}
103 }