1 /*
2  * Copyright (C) 2009 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package signature.compare;
18 
19 import signature.compare.model.IApiDelta;
20 import signature.model.IApi;
21 
22 /**
23  * {@code IApiComparator} defines the functionality of a signature comparator.
24  */
25 public interface IApiComparator {
26 
27     /**
28      * Returns a difference model which describes the differences from {@code
29      * fromApi} to {@code toApi}.
30      *
31      * @param fromApi
32      *            differences are computed relative to {@code fromApi}
33      * @param toApi
34      *            the target signature model
35      * @return a difference model which describes the differences from {@code
36      *         fromApi} to {@code toApi}
37      */
compare(IApi fromApi, IApi toApi)38     IApiDelta compare(IApi fromApi, IApi toApi);
39 }
40