1 /**
2 * Copyright (c) 2011, University of Konstanz, Distributed Systems Group
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of Konstanz nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 package org.treetank.service.xml.diff;
29
30 import org.treetank.node.interfaces.IStructNode;
31 import org.treetank.service.xml.diff.DiffFactory.EDiff;
32
33 /**
34 * Container for diffs.
35 *
36 * @author Johannes Lichtenberger, University of Konstanz
37 *
38 */
39 public final class Diff {
40 /** {@link EDiff} which specifies the kind of diff between two nodes. */
41 private final EDiff mDiff;
42
43 /** {@link IStructNode} in new revision. */
44 private final IStructNode mNewNode;
45
46 /** {@link IStructNode} in old revision. */
47 private final IStructNode mOldNode;
48
49 /** {@link DiffDepth} instance. */
50 private final DiffDepth mDepth;
51
52 /**
53 * Constructor.
54 *
55 * @param paramDiff
56 * {@link EDiff} which specifies the kind of diff between two
57 * nodes
58 * @param paramNewNode
59 * {@link IStructNode} in new revision
60 * @param paramOldNode
61 * {@link IStructNode} in old revision
62 * @param paramDepth
63 * current {@link DiffDepth} instance
64 */
65 public Diff(final EDiff paramDiff, final IStructNode paramNewNode, final IStructNode paramOldNode,
66 final DiffDepth paramDepth) {
67 assert paramDiff != null;
68 assert paramNewNode != null;
69 assert paramOldNode != null;
70 assert paramDepth != null;
71
72 mDiff = paramDiff;
73 mNewNode = paramNewNode;
74 mOldNode = paramOldNode;
75 mDepth = paramDepth;
76 }
77
78 /**
79 * Get diff.
80 *
81 * @return the kind of diff
82 */
83 public EDiff getDiff() {
84 return mDiff;
85 }
86
87 /**
88 * Get new node.
89 *
90 * @return the new node
91 */
92 public IStructNode getNewNode() {
93 return mNewNode;
94 }
95
96 /**
97 * Get old node.
98 *
99 * @return the old node
100 */
101 public IStructNode getOldNode() {
102 return mOldNode;
103 }
104
105 /**
106 * Get depth.
107 *
108 * @return the depth
109 */
110 public DiffDepth getDepth() {
111 return mDepth;
112 }
113
114 @Override
115 public String toString() {
116 return new StringBuilder("diff: ").append(mDiff).append(" new node: ").append(mNewNode).append(
117 " old node: ").append(mOldNode).toString();
118 }
119 }