1 /*
2 * Copyright (C) 2017, Thomas Wolf <thomas.wolf@paranor.ch>
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.events;
44
45 import java.util.Collection;
46 import java.util.Collections;
47
48 import org.eclipse.jgit.annotations.NonNull;
49
50 /**
51 * A {@link org.eclipse.jgit.events.RepositoryEvent} describing changes to the
52 * working tree. It is fired whenever a
53 * {@link org.eclipse.jgit.dircache.DirCacheCheckout} modifies
54 * (adds/deletes/updates) files in the working tree.
55 *
56 * @since 4.9
57 */
58 public class WorkingTreeModifiedEvent
59 extends RepositoryEvent<WorkingTreeModifiedListener> {
60
61 private Collection<String> modified;
62
63 private Collection<String> deleted;
64
65 /**
66 * Creates a new {@link org.eclipse.jgit.events.WorkingTreeModifiedEvent}
67 * with the given collections.
68 *
69 * @param modified
70 * repository-relative paths that were added or updated
71 * @param deleted
72 * repository-relative paths that were deleted
73 */
74 public WorkingTreeModifiedEvent(Collection<String> modified,
75 Collection<String> deleted) {
76 this.modified = modified;
77 this.deleted = deleted;
78 }
79
80 /**
81 * Determines whether there are any changes recorded in this event.
82 *
83 * @return {@code true} if no files were modified or deleted, {@code false}
84 * otherwise
85 */
86 public boolean isEmpty() {
87 return (modified == null || modified.isEmpty())
88 && (deleted == null || deleted.isEmpty());
89 }
90
91 /**
92 * Retrieves the {@link java.util.Collection} of repository-relative paths
93 * of files that were modified (added or updated).
94 *
95 * @return the set
96 */
97 @NonNull
98 public Collection<String> getModified() {
99 Collection<String> result = modified;
100 if (result == null) {
101 result = Collections.emptyList();
102 modified = result;
103 }
104 return result;
105 }
106
107 /**
108 * Retrieves the {@link java.util.Collection} of repository-relative paths
109 * of files that were deleted.
110 *
111 * @return the set
112 */
113 @NonNull
114 public Collection<String> getDeleted() {
115 Collection<String> result = deleted;
116 if (result == null) {
117 result = Collections.emptyList();
118 deleted = result;
119 }
120 return result;
121 }
122
123 /** {@inheritDoc} */
124 @Override
125 public Class<WorkingTreeModifiedListener> getListenerType() {
126 return WorkingTreeModifiedListener.class;
127 }
128
129 /** {@inheritDoc} */
130 @Override
131 public void dispatch(WorkingTreeModifiedListener listener) {
132 listener.onWorkingTreeModified(this);
133 }
134 }