1 /*
2 * #%L
3 * wcm.io
4 * %%
5 * Copyright (C) 2018 wcm.io
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package io.wcm.caravan.hal.comparison.impl.matching;
21
22 import java.util.List;
23
24 /**
25 * An algorithm that finds matching pairs in the two given lists
26 * @param <T> the type of the items to match
27 */
28 public interface MatchingAlgorithm<T> {
29
30 /**
31 * @param expectedList
32 * @param actualList
33 * @return a {@link MatchingResult} instance
34 */
35 MatchingResult<T> findMatchingItems(List<T> expectedList, List<T> actualList);
36
37 }