---
name: "Debian::Javahelper::Java"
section: "3"
platform: "linux"
package: "javahelper"
version: "0.80"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Debian::Javahelper::Java"
---

# Debian::Javahelper::Java(3)

Javahelper core library.

## NAME

Debian::Javahelper::Java - Javahelper core library.

## SYNOPSIS

```
 use Debian::Javahelper::Java;

 my @paths = scan_javadoc("/usr/share/doc/libfreemarker-doc/api/");
 print "Freemarker is linked to the following APIs: \n - ",
       join("\n - ", @paths), "\n";
 my @packnames = find_package_for_existing_files("/bin/ls",
                 "/bin/bash");
 print "/bin/ls and /bin/bash are installed via: ",
       join(", ", @packnames), "\n";
```

## DESCRIPTION

This module is used by various javahelpers to share common code.

Please note this API is not stable and backwards compatibility is not guaranteed at the current time. Please contact the maintainers if you are interested in a stable API.

### Methods

- scan\_javadoc($path)

  Scans the javadoc at **$path** and returns a list of javadocs it is linked to on the system.

  Currently it ignores all javadocs linked via other locations than */usr/share/doc* and it also makes an assumption that the linked javadoc is in /usr/share/doc/\<package\>/\<dir-or-symlink\>. Of course, all Java Policy compliant packages provide their javadoc from there.

  If /usr/share/doc/\<package\>/\<dir-or-symlink\> appears to be a symlink, then it is followed (except for default-jdk-doc).

- find\_package\_for\_existing\_files(@files)

  Consults [**dpkg**(1)](/dpkg/1.md) to see which packages provides **@files** and returns this list. All entries in **@files** must exists (but is not required to be files) and should not be used on a directory.

  Furthermore all entries must be given with absolute path.

- parse\_manifest\_fd($fd, $filename)

  Parses a manifest from **$fd**, which must be a readable filehandle, and returns a Debian::Javahelper::Manifest.

  **$filename** is only used to report parsing errors and should be something that identifies the source of **$fd**.

- write\_manifest\_fd($manifest, $fd, $filename)

  Writes **$manifest** to the writable filehandle **$fd**. **$manifest** must be a Debian::Javahelper::Manifest.

  **$filename** is only used to report errors and should be something that identifies **$fd**.

- write\_manifest\_section\_fd($section, $fd, $filename)

  Writes **$section** to the writable filehandle **$fd**. **$section** must be a Debian::Javahelper::ManifestSection.

  **$filename** is only used to report errors and should be something that identifies **$fd**.

  NB: Helper - Not exported.

- slurp\_file($file)

  Reads all lines in **$file** and returns them as a list.

  NB: Helper - Not exported.

## SEE ALSO

[**Debian::Javahelper::Manifest**(3)](/Debian::Javahelper::Manifest/3.md) [**Debian::Javahelper::ManifestSection**(3)](/Debian::Javahelper::ManifestSection/3.md)

## AUTHOR

Niels Thykier \<niels@thykier.net\>

## COPYRIGHT AND LICENSE

Copyright 2010 by Niels Thykier

This module is free software; you may redistribute it and/or modify it under the terms of GNU GPL 2.