1 /**
2 * This file Copyright (c) 2016-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.resourceloader;
35
36 import lombok.Value;
37
38 /**
39 * Provides context information about a {@link Resource resource} related change.
40 *
41 * @see ResourceChangeHandler
42 * @see ResourceOrigin#registerResourceChangeHandler(ResourceChangeHandler)
43 */
44 @Value
45 public final class ResourceOriginChange {
46
47 public static Builder resourceChange() {
48 return new Builder();
49 }
50
51 private Type type;
52 private String relatedResourcePath;
53 private ResourceOrigin relatedOrigin;
54
55 /**
56 * Enumeration of possible {@link ResourceOriginChange resource change} types.
57 */
58 public enum Type {
59 MODIFIED,
60 ADDED,
61 REMOVED
62 }
63
64 /**
65 * Builder utility to ease the construction of {@link ResourceOriginChange}. Obtain an instance of this builder
66 * via static {@link ResourceOriginChange#resourceChange()} method.
67 */
68 public final static class Builder {
69 Type type;
70 String relatedResourcePath;
71 ResourceOrigin relatedOrigin;
72
73 private Builder() {}
74
75 public Builder ofType(Type type) {
76 this.type = type;
77 return this;
78 }
79
80 public Builder at(String changedResourcePath) {
81 this.relatedResourcePath = changedResourcePath;
82 return this;
83 }
84
85 public Builder inOrigin(ResourceOrigin actualChangedOrigin) {
86 this.relatedOrigin = actualChangedOrigin;
87 return this;
88 }
89
90 public ResourceOriginChange build() {
91 return new ResourceOriginChange(type, relatedResourcePath, relatedOrigin);
92 }
93 }
94 }