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