original

[gb-231r1-is01/GB_2.3_IS01.git] / cts / tools / signature-tools / src / signature / compare / IApiComparator.java

diff --git a/cts/tools/signature-tools/src/signature/compare/IApiComparator.java b/cts/tools/signature-tools/src/signature/compare/IApiComparator.java
new file mode 100644 (file)
index 0000000..08ed97f
--- /dev/null
+++ b/cts/tools/signature-tools/src/signature/compare/IApiComparator.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright (C) 2009 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package signature.compare;
+
+import signature.compare.model.IApiDelta;
+import signature.model.IApi;
+
+/**
+ * {@code IApiComparator} defines the functionality of a signature comparator.
+ */
+public interface IApiComparator {
+
+    /**
+     * Returns a difference model which describes the differences from {@code
+     * fromApi} to {@code toApi}.
+     * 
+     * @param fromApi
+     *            differences are computed relative to {@code fromApi}
+     * @param toApi
+     *            the target signature model
+     * @return a difference model which describes the differences from {@code
+     *         fromApi} to {@code toApi}
+     */
+    IApiDelta compare(IApi fromApi, IApi toApi);
+}