debian::javahelper::java(3) [debian man page]

Debian::Javahelper::Java(3)					    Javahelper					       Debian::Javahelper::Java(3)

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: 
 - ",
	      join("
 - ", @paths), "
";
	my @packnames = find_package_for_existing_files("/bin/ls",
			"/bin/bash");
	print "/bin/ls and /bin/bash are installed via: ",
	      join(", ", @packnames), "
";

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) 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::ManifestSection(3)

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.

0.43								    2012-01-10					       Debian::Javahelper::Java(3)

Debian::Javahelper::Eclipse(3)					    Javahelper					    Debian::Javahelper::Eclipse(3)

NAME

       Debian::Javahelper::Eclipse - Eclipse Helper Library.

SYNOPSIS

	use Debian::Javahelper::Eclipse;

	my @orbitdeps = ();
	push(@orbitdeps, {
	    EOB_SYM_NAME => 'org.apache.commons.net',
	    EOB_SYS_JAR  => '/usr/share/java/commons-net2.jar'});
	#...
	# Install the feature to "$dropins/$name"
	install_zipped_feature($zip, "$dropins/$name");
	#  and symlink the following orbitdeps.
	install_zipped_feature($zip, "$dropins/$name", @orbitdeps);

DESCRIPTION

       This module is used by the eclipse related 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.

   Definitions
       A bundle refers to a jar file. An orbit dependency (a.k.a orbitdep) is a bundle, which is used by eclipse or one of its features without
       being a part of eclipse or said feature.

       This module keeps track of bundles via hashes; see the EOB_* constants for relevant keys (and their expected values).

   Constants
       EOB_SYM_NAME
	   Key for hashes to fetch the symbolic name of a bundle.

       EOB_BUNDLE_VERSION
	   Key for hashes to fetch the version of a bundle.

       EOB_SYS_JAR
	   Key for hashes to fetch the path to the system installed jar file.

	   Only valid for an orbit dependency and cannot be used with manifests.

   Methods
       install_zipped_feature($fzip, $loc[, $orbitdeps[, $package, $needs]])
	   Unpacks the zipped feature $fzip into $loc, which should be a subfolder of a dropins folder (e.g. /usr/share/eclipse/dropins/emf). This
	   can also be used to install the feature into a "build environment". In this case it should be installed into the same folder as the SDK
	   is (this folder is usually called "SDK").

	   If $orbitdeps is present, it should be an ARRAY ref containing orbit dependencies, which will be symlinked after unpacking. This sub
	   only needs the EOB_SYM_NAME and EOB_SYS_JAR to be set and valid. Orbit dependencies not present in the installed folder will be
	   ignored, so it is safe to have unrelated orbit dependencies in the ARRAY ref.

	   If $package and $needs are present, the former should be the name of a debian package and the latter a hashref. The sub will populate
	   the $needs hashref with which orbit dependencies are used by the package.  The $needs hashref can be re-used in multiple calls to this
	   sub.

	   Keys in $needs will be the path to the orbit jar's real location (EOB_SYS_JAR) and the value a new hashref. This hashref has as keys
	   the names of packages and as values 1. The $needs is used by jh_installeclipse to populate the ${orbit:Depends} variables for packages.

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.

0.43								    2011-02-17					    Debian::Javahelper::Eclipse(3)