View Javadoc
1   /*
2    * Copyright (C) 2010, Google Inc.
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  
44  package org.eclipse.jgit.diff;
45  
46  /**
47   * Wraps two {@link org.eclipse.jgit.diff.Sequence} instances to cache their
48   * element hash codes.
49   * <p>
50   * This pair wraps two sequences that contain cached hash codes for the input
51   * sequences.
52   *
53   * @param <S>
54   *            the base sequence type.
55   */
56  public class HashedSequencePair<S extends Sequence> {
57  	private final SequenceComparator<? super S> cmp;
58  
59  	private final S baseA;
60  
61  	private final S baseB;
62  
63  	private HashedSequence<S> cachedA;
64  
65  	private HashedSequence<S> cachedB;
66  
67  	/**
68  	 * Construct a pair to provide fast hash codes.
69  	 *
70  	 * @param cmp
71  	 *            the base comparator for the sequence elements.
72  	 * @param a
73  	 *            the A sequence.
74  	 * @param b
75  	 *            the B sequence.
76  	 */
77  	public HashedSequencePair(SequenceComparator<? super S> cmp, S a, S b) {
78  		this.cmp = cmp;
79  		this.baseA = a;
80  		this.baseB = b;
81  	}
82  
83  	/**
84  	 * Get comparator
85  	 *
86  	 * @return obtain a comparator that uses the cached hash codes
87  	 */
88  	public HashedSequenceComparator<S> getComparator() {
89  		return new HashedSequenceComparator<>(cmp);
90  	}
91  
92  	/**
93  	 * Get A
94  	 *
95  	 * @return wrapper around A that includes cached hash codes
96  	 */
97  	public HashedSequence<S> getA() {
98  		if (cachedA == null)
99  			cachedA = wrap(baseA);
100 		return cachedA;
101 	}
102 
103 	/**
104 	 * Get B
105 	 *
106 	 * @return wrapper around B that includes cached hash codes
107 	 */
108 	public HashedSequence<S> getB() {
109 		if (cachedB == null)
110 			cachedB = wrap(baseB);
111 		return cachedB;
112 	}
113 
114 	private HashedSequence<S> wrap(S base) {
115 		final int end = base.size();
116 		final int[] hashes = new int[end];
117 		for (int ptr = 0; ptr < end; ptr++)
118 			hashes[ptr] = cmp.hash(base, ptr);
119 		return new HashedSequence<>(base, hashes);
120 	}
121 }