|
|
@@ -16,11 +16,9 @@ This fork focuses on the development of a new Java API for JPlag.
|
|
|
|
|
|
You'll find the generated JAR with all dependencies in `jplag/target`.
|
|
|
|
|
|
-## (Breaking) Changes
|
|
|
+## (Breaking) Changes coming with the v3.0.0 release
|
|
|
|
|
|
-> Note: The following list of changes doesn't claim to be complete and is intended to give a rough overview of the changes introduced with this fork.
|
|
|
-
|
|
|
-This fork made the following (breaking) changes to the JPlag repository:
|
|
|
+> Note: The following list of changes doesn't claim to be complete and is intended to give a rough overview of the changes.
|
|
|
|
|
|
* Removed folders related to (deprecated) web services: `adminTool`, `atujplag`, `homepage`, `maven-libs`, `webService`, and `wsClient`
|
|
|
* Deleted unnecessary resources from `jplag/src/main/resources`
|
|
|
@@ -34,11 +32,6 @@ This fork made the following (breaking) changes to the JPlag repository:
|
|
|
* The new `JPlagComparison` class replaces the old `AllMatches` class.
|
|
|
* We removed `AvgComparator`, `AvgReversedComparator`, `MaxComparator`, `MaxReversedComparator`, `MinComparator`, and `MinReversedComparator` from the `JPlagComparison` (previously `AllMatches`) class. All comparisons are now sorted by average similarity. The `JPlagResult` and `JPlagComparison` classes should make adding a custom sorting logic very straightforward if that's required.
|
|
|
|
|
|
-In addition, without referring to any specifics, this fork also includes:
|
|
|
-* Tons of code formatting & restructuring
|
|
|
-* Renaming of classes, files, and functions
|
|
|
-* Deletion of unused code
|
|
|
-
|
|
|
## Usage
|
|
|
|
|
|
### CLI
|
|
|
@@ -101,8 +94,9 @@ report.writeResult(result);
|
|
|
```
|
|
|
|
|
|
#### Class Diagram
|
|
|
-
|
|
|
-
|
|
|
+<p align="center">
|
|
|
+ <img alt="UMLClassDiagram.png" src="UMLClassDiagram.png?raw=true" width="800">
|
|
|
+</p>
|
|
|
|
|
|
## Concepts
|
|
|
|
Timur Sağlam