1 /*
2 * Copyright (C) 2010, Google Inc.
3 * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
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.events;
46
47 import org.eclipse.jgit.lib.Repository;
48
49 /**
50 * Describes a modification made to a repository.
51 *
52 * @param <T>
53 * type of listener this event dispatches to.
54 */
55 public abstract class RepositoryEvent<T extends RepositoryListener> {
56 private Repository repository;
57
58 /**
59 * Set the repository this event occurred on.
60 * <p>
61 * This method should only be invoked once on each event object, and is
62 * automatically set by
63 * {@link org.eclipse.jgit.lib.Repository#fireEvent(RepositoryEvent)}.
64 *
65 * @param r
66 * the repository.
67 */
68 public void setRepository(Repository r) {
69 if (repository == null)
70 repository = r;
71 }
72
73 /**
74 * Get the repository that was changed
75 *
76 * @return the repository that was changed
77 */
78 public Repository getRepository() {
79 return repository;
80 }
81
82 /**
83 * Get type of listener this event dispatches to
84 *
85 * @return type of listener this event dispatches to
86 */
87 public abstract Class<T> getListenerType();
88
89 /**
90 * Dispatch this event to the given listener.
91 *
92 * @param listener
93 * listener that wants this event.
94 */
95 public abstract void dispatch(T listener);
96
97 /** {@inheritDoc} */
98 @SuppressWarnings("nls")
99 @Override
100 public String toString() {
101 String type = getClass().getSimpleName();
102 if (repository == null)
103 return type;
104 return type + "[" + repository + "]";
105 }
106 }