1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.lang3.builder;
18
19 /**
20 * {@link Diffable} classes can be compared with other objects
21 * for differences. The {@link DiffResult} object retrieved can be queried
22 * for a list of differences or printed using the {@link DiffResult#toString()}.
23 *
24 * <p>
25 * The calculation of the differences is <em>consistent with equals</em> if
26 * and only if {@code d1.equals(d2)} implies {@code d1.diff(d2) == ""}.
27 * It is strongly recommended that implementations are consistent with equals
28 * to avoid confusion. Note that {@code null} is not an instance of any class
29 * and {@code d1.diff(null)} should throw a {@link NullPointerException}.
30 * </p>
31 *
32 * <p>
33 * {@link Diffable} classes lend themselves well to unit testing, in which a
34 * easily readable description of the differences between an anticipated result and
35 * an actual result can be retrieved. For example:
36 * </p>
37 * <pre>
38 * Assert.assertEquals(expected.diff(result), expected, result);
39 * </pre>
40 *
41 * @param <T> The type of objects that this object may be differentiated against
42 * @since 3.3
43 */
44 @FunctionalInterface
45 public interface Diffable<T> {
46
47 /**
48 * Retrieves a list of the differences between
49 * this object and the supplied object.
50 *
51 * @param obj The object to diff against, can be {@code null}
52 * @return A list of differences
53 * @throws NullPointerException Thrown if the specified object is {@code null}.
54 */
55 DiffResult<T> diff(T obj);
56 }