Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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)

Check Out this Related Man Page

Debian::Javahelper::Manifest(3) 				    Javahelper					   Debian::Javahelper::Manifest(3)

NAME

       Debian::Javahelper::Manifest - Javahelper representation of a Jar Manifest

SYNOPSIS

	use Debian::Javahelper::Java;

	my $manifest = ...;
	my $main_sec = $manifest->get_section(MAIN_SECTION);
	# Create if it does not exist.
	my $file_sec = $manifest->get_section("java/lang/Object.class", 1);

DESCRIPTION

       This module is used to represent a Java Manifest.

   Constants
       MAIN_SECTION
	   A constant denoting the main section of the manifest.

	   Exported by default.

   Methods
       Debian::Javahelper::Manifest->new()
	   Creates a new manifest. It will only contain the main section with the Manifest-Version attribute.

       $manifest->get_section($name[, $create])
	   Returns the section denoted by $name. If this section does not exist, then it will either return undef or (if $create is a truth-value)
	   create a new empty section with that name.

	   Use the MAIN_SECTION constant to access the main section of the manifest.

       $manifest->get_sections()
	   Returns a list of all sections in $manifest. The main section will always be the first in the list, but the remaining sections can come
	   in any order (and this order can change in later invocations).

	   Modifying the list will not change which sections are present in $manifest, but modifying a section in this list will also update the
	   section in the manifest.

       $manifest->merge($other)
	   Merge all entries in $other into $manifest. All sections in $other will be added to $manifest if they are not already present.

	   If an attribute in a given section is only present in one of the two manifests, then that attribute and its value will be in $manifest
	   after merge returns.

	   If the attribute in a given section is present in both manifests, then the value from $other will be used.

	   This can be used to make a deep copy a manifest:

	    my $copy = Debian::Javahelper::Manifest->new();
	    $copy->merge($orig);

SEE ALSO

       Debian::Javahelper::Java(3) - had parse/write methods for manifests.  Debian::Javahelper::ManifestSection(3) - for how sections are
       handled.

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::Manifest(3)
Man Page