#381

Committed 29 Apr 2025 02:09PM UTC coverage: 88.884%. First build

Build # #381

Build Type

Pull #233

github

Committed by

Pfeil

Commit Message

feat: add Javadoc generation step to CI pipeline

Pull Request Pull Request #233: Version 2.1.0

Run Details

598 of 700 new or added lines in 28 files covered. (85.43%)

1879 of 2114 relevant lines covered (88.88%)

0.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/java/edu/kit/datamanager/ro_crate/reader/ZipReader.java

package edu.kit.datamanager.ro_crate.reader;

import java.nio.file.Path;

/**
 * A ReaderStrategy implementation which reads from ZipFiles.
 * <p>
 * May be used as a dependency for RoCrateReader. It will unzip
 * the ZipFile in a path relative to the directory this application runs in.
 * By default, it will be `./.tmp/ro-crate-java/zipReader/$UUID/`.
 * <p>
 * NOTE: The resulting crate may refer to these temporary files. Therefore,
 * these files are only being deleted before the JVM exits. If you need to free
 * space because your application is long-running or creates a lot of
 * crates, you may use the getters to retrieve information which will help
 * you to clean up manually. Keep in mind that crates may refer to this
 * folder after extraction. Use RoCrateWriter to export it so some
 * persistent location and possibly read it from there, if required. Or use
 * the ZipWriter to write it back to its source.
 *
 * @deprecated Use {@link ZipStrategy} instead.
 */
@Deprecated(since = "2.1.0", forRemoval = true)
public class ZipReader extends ZipStrategy {

  /**
   * Crates a ZipReader with the default configuration as described in the class documentation.
   */
  public ZipReader() {
    super();
  }

  /**
   * Creates a ZipReader which will extract the contents temporary
   * to the given location instead of the default location.
   *
   * @param folderPath            the custom directory to extract
   *                              content to for temporary access.
   * @param shallAddUuidSubfolder if true, the reader will extract
   *                              into subdirectories of the given
   *                              directory. These subdirectories
   *                              will have UUIDs as their names.
   */
  public ZipReader(Path folderPath, boolean shallAddUuidSubfolder) {
    super(folderPath, shallAddUuidSubfolder);
  }
}

1	package edu.kit.datamanager.ro_crate.reader;
2
3	import java.nio.file.Path;
4
5	/**
6	* A ReaderStrategy implementation which reads from ZipFiles.
7	* <p>
8	* May be used as a dependency for RoCrateReader. It will unzip
9	* the ZipFile in a path relative to the directory this application runs in.
10	* By default, it will be `./.tmp/ro-crate-java/zipReader/$UUID/`.
11	* <p>
12	* NOTE: The resulting crate may refer to these temporary files. Therefore,
13	* these files are only being deleted before the JVM exits. If you need to free
14	* space because your application is long-running or creates a lot of
15	* crates, you may use the getters to retrieve information which will help
16	* you to clean up manually. Keep in mind that crates may refer to this
17	* folder after extraction. Use RoCrateWriter to export it so some
18	* persistent location and possibly read it from there, if required. Or use
19	* the ZipWriter to write it back to its source.
20	*
21	* @deprecated Use {@link ZipStrategy} instead.
22	*/
23	@Deprecated(since = "2.1.0", forRemoval = true)
24	public class ZipReader extends ZipStrategy {
25
26	/**
27	* Crates a ZipReader with the default configuration as described in the class documentation.
28	*/
29	public ZipReader() {
NEW 30	super();	×
NEW 31	}	×
32
33	/**
34	* Creates a ZipReader which will extract the contents temporary
35	* to the given location instead of the default location.
36	*
37	* @param folderPath the custom directory to extract
38	* content to for temporary access.
39	* @param shallAddUuidSubfolder if true, the reader will extract
40	* into subdirectories of the given
41	* directory. These subdirectories
42	* will have UUIDs as their names.
43	*/
44	public ZipReader(Path folderPath, boolean shallAddUuidSubfolder) {
NEW 45	super(folderPath, shallAddUuidSubfolder);	×
46	}	×
47	}

kit-data-manager / ro-crate-java / #381

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous