.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Debian::Javahelper::Eclipse 3"
.TH Debian::Javahelper::Eclipse 3 "2014-12-12" "0.48+deb8u1" "Javahelper"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Debian::Javahelper::Eclipse \- Eclipse Helper Library.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Debian::Javahelper::Eclipse;
\&
\& my @orbitdeps = ();
\& push(@orbitdeps, {
\&     EOB_SYM_NAME => \*(Aqorg.apache.commons.net\*(Aq,
\&     EOB_SYS_JAR  => \*(Aq/usr/share/java/commons\-net2.jar\*(Aq});
\& #...
\& # Install the feature to "$dropins/$name"
\& install_zipped_feature($zip, "$dropins/$name");
\& #  and symlink the following orbitdeps.
\& install_zipped_feature($zip, "$dropins/$name", @orbitdeps);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is used by the eclipse related javahelpers to share
common code.
.PP
Please note this \s-1API\s0 is not stable and backwards compatibility is not
guaranteed at the current time. Please contact the maintainers if you
are interested in a stable \s-1API.\s0
.SS "Definitions"
.IX Subsection "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.
.PP
This module keeps track of bundles via hashes; see the EOB_*
constants for relevant keys (and their expected values).
.SS "Constants"
.IX Subsection "Constants"
.IP "\s-1EOB_SYM_NAME\s0" 4
.IX Item "EOB_SYM_NAME"
Key for hashes to fetch the symbolic name of a bundle.
.IP "\s-1EOB_BUNDLE_VERSION\s0" 4
.IX Item "EOB_BUNDLE_VERSION"
Key for hashes to fetch the version of a bundle.
.IP "\s-1EOB_SYS_JAR\s0" 4
.IX Item "EOB_SYS_JAR"
Key for hashes to fetch the path to the system installed jar file.
.Sp
Only valid for an orbit dependency and cannot be used with manifests.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP "install_zipped_feature($fzip, $loc[, $orbitdeps[, $package, $needs]])" 4
.el .IP "install_zipped_feature($fzip, \f(CW$loc\fR[, \f(CW$orbitdeps\fR[, \f(CW$package\fR, \f(CW$needs\fR]])" 4
.IX Item "install_zipped_feature($fzip, $loc[, $orbitdeps[, $package, $needs]])"
Unpacks the zipped feature \f(CW$fzip\fR into \f(CW$loc\fR, 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 \*(L"build environment\*(R". In this case
it should be installed into the same folder as the \s-1SDK\s0 is
(this folder is usually called \*(L"\s-1SDK\*(R"\s0).
.Sp
If \f(CW$orbitdeps\fR is present, it should be an \s-1ARRAY\s0 ref containing orbit
dependencies, which will be symlinked after unpacking. This sub only
needs the \s-1EOB_SYM_NAME\s0 and \s-1EOB_SYS_JAR\s0 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 \s-1ARRAY\s0 ref.
.Sp
If \f(CW$package\fR and \f(CW$needs\fR are present, the former should be the name
of a debian package and the latter a hashref. The sub will populate the
\&\f(CW$needs\fR hashref with which orbit dependencies are used by the package.
The \f(CW$needs\fR hashref can be re-used in multiple calls to this sub.
.Sp
Keys in \f(CW$needs\fR will be the path to the orbit jar's real location
(\s-1EOB_SYS_JAR\s0) and the value a new hashref. This hashref has as keys the
names of packages and as values 1. The \f(CW$needs\fR is used by
jh_installeclipse to populate the ${orbit:Depends} variables for packages.
.SH "AUTHOR"
.IX Header "AUTHOR"
Niels Thykier <niels@thykier.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2010 by Niels Thykier
.PP
This module is free software; you may redistribute it and/or modify
it under the terms of \s-1GNU GPL 2.\s0