Improve documentation

markusweigelt · Jan 2, 2024 · f42a188 · f42a188
1 parent 0ca03d8
commit f42a188
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 4 deletions.
diff --git a/Kitodo-API/src/main/java/org/kitodo/api/dataformat/MediaPartialView.java b/Kitodo-API/src/main/java/org/kitodo/api/dataformat/MediaPartialView.java
@@ -19,10 +19,27 @@ public class MediaPartialView extends View {
 
     private String extent;
 
+    /**
+     * Constructs a media partial view object.
+     *
+     * @param begin
+     *         The begin as formatted time in form of
+     *         {@link org.kitodo.production.helper.metadata.MediaPartialHelper#FORMATTED_TIME_PATTERN}
+     */
     public MediaPartialView(String begin) {
         this.begin = begin;
     }
 
+    /**
+     * Constructs a media partial view object.
+     *
+     * @param begin
+     *         The begin as formatted time in form of
+     *         {@link org.kitodo.production.helper.metadata.MediaPartialHelper#FORMATTED_TIME_PATTERN}
+     * @param extent
+     *         The extent as formatted time in form of
+     *         {@link org.kitodo.production.helper.metadata.MediaPartialHelper#FORMATTED_TIME_PATTERN}
+     */
     public MediaPartialView(String begin, String extent) {
         this(begin);
         this.extent = extent;

diff --git a/Kitodo/src/main/java/org/kitodo/production/helper/metadata/MediaPartialHelper.java b/Kitodo/src/main/java/org/kitodo/production/helper/metadata/MediaPartialHelper.java
@@ -29,7 +29,7 @@ public class MediaPartialHelper {
 
     public static final Pattern FORMATTED_TIME_PATTERN = Pattern.compile("([0-1]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}");
 
-    private static final MediaPartialLogicalDivisionComparator mediaPartialLogicalDivisionComparator = new MediaPartialLogicalDivisionComparator();
+    private static final MediaPartialLogicalDivisionComparator logicalDivisionComparator = new MediaPartialLogicalDivisionComparator();
 
     /**
      * Convert formatted time to milliseconds.
@@ -65,7 +65,7 @@ public static String convertMillisecondsToFormattedTime(Long milliseconds) {
      */
     public static void calculateExtentAndSortMediaPartials(List<LogicalDivision> logicalDivisions, Long mediaDuration) {
         calculateExtentForMediaPartials(logicalDivisions, mediaDuration);
-        logicalDivisions.sort(mediaPartialLogicalDivisionComparator);
+        logicalDivisions.sort(logicalDivisionComparator);
     }
 
     /**
@@ -81,7 +81,7 @@ public static void calculateExtentAndSortMediaPartials(List<LogicalDivision> log
      */
     private static void calculateExtentForMediaPartials(List<LogicalDivision> logicalDivisions, Long mediaDuration) {
         // sorting reverse by begin
-        logicalDivisions.sort(mediaPartialLogicalDivisionComparator.reversed());
+        logicalDivisions.sort(logicalDivisionComparator.reversed());
 
         ListIterator<LogicalDivision> iterator = logicalDivisions.listIterator();
         LogicalDivision previousLogicalDivision = null;
@@ -97,7 +97,8 @@ private static void calculateExtentForMediaPartials(List<LogicalDivision> logica
                     long previousBegin = convertFormattedTimeToMilliseconds(
                             previousPhysicalDivision.getMediaPartialView().getBegin());
                     long currentBegin = convertFormattedTimeToMilliseconds(mediaPartialView.getBegin());
-                    mediaPartialView.setExtent(convertMillisecondsToFormattedTime(previousBegin - currentBegin));
+                    String extent = convertMillisecondsToFormattedTime(previousBegin - currentBegin);
+                    mediaPartialView.setExtent(extent);
                 }
             } else {
                 // calculate the duration of media partial to the end of media