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.internal.storage.dfs;
45
46 import org.eclipse.jgit.events.RepositoryEvent;
47
48 /**
49 * Describes the {@link org.eclipse.jgit.internal.storage.dfs.DfsPackFile} just
50 * before its index is loaded. Currently, DfsPackFile directly dispatches the
51 * event on {@link org.eclipse.jgit.lib.Repository#getGlobalListenerList}. Which
52 * means the call to {@link #getRepository} will always return null.
53 */
54 public class BeforeDfsPackIndexLoadedEvent
55 extends RepositoryEvent<BeforeDfsPackIndexLoadedListener> {
56 private final DfsPackFile pack;
57
58 /**
59 * A new event triggered before a PackFile index is loaded.
60 *
61 * @param pack
62 * the pack
63 */
64 public BeforeDfsPackIndexLoadedEvent(DfsPackFile pack) {
65 this.pack = pack;
66 }
67
68 /**
69 * Get the PackFile containing the index that will be loaded.
70 *
71 * @return the PackFile containing the index that will be loaded.
72 */
73 public DfsPackFile getPackFile() {
74 return pack;
75 }
76
77 /** {@inheritDoc} */
78 @Override
79 public Class<BeforeDfsPackIndexLoadedListener> getListenerType() {
80 return BeforeDfsPackIndexLoadedListener.class;
81 }
82
83 /** {@inheritDoc} */
84 @Override
85 public void dispatch(BeforeDfsPackIndexLoadedListener listener) {
86 listener.onBeforeDfsPackIndexLoaded(this);
87 }
88 }