com.springsource.util.osgi.manifest
Interface ExportedPackage

All Superinterfaces:
Parameterised, Parseable
All Known Implementing Classes:
StandardExportedPackage

public interface ExportedPackage
extends Parameterised

Represents a single entry in a bundle's Export-Package header.

Concurrent Semantics
May not be thread-safe.


Method Summary
 java.util.List<java.lang.String> getExclude()
          Returns a list of the class names specified in the export's exclude directive.
 java.util.List<java.lang.String> getInclude()
          Returns a list of the class names specified in the export's include directive.
 java.util.List<java.lang.String> getMandatory()
          Returns a list of the attribute names specified in the export's mandatory directive.
 java.lang.String getPackageName()
          Returns the name of the exported package, never null.
 java.util.List<java.lang.String> getUses()
          Returns a List of the package names specified in the export's uses directive.
 org.osgi.framework.Version getVersion()
          Returns the version of the exported package.
 void setPackageName(java.lang.String packageName)
          Sets the name of the exported package.
 void setVersion(org.osgi.framework.Version version)
          Sets the version of the exported package
 
Methods inherited from interface com.springsource.util.osgi.manifest.Parameterised
getAttributes, getDirectives
 
Methods inherited from interface com.springsource.util.osgi.manifest.Parseable
resetFromParseString, toParseString
 

Method Detail

getPackageName

java.lang.String getPackageName()
Returns the name of the exported package, never null.

Returns:
the package name

setPackageName

void setPackageName(java.lang.String packageName)
                    throws java.lang.IllegalArgumentException
Sets the name of the exported package.

Parameters:
packageName - the package name
Throws:
java.lang.IllegalArgumentException - if the given package name is null

getVersion

org.osgi.framework.Version getVersion()
Returns the version of the exported package.

Returns:
the version of the exported package. Returns the default version (0) if the export has no version.

setVersion

void setVersion(org.osgi.framework.Version version)
Sets the version of the exported package

Parameters:
version - The exported package's version

getUses

java.util.List<java.lang.String> getUses()
Returns a List of the package names specified in the export's uses directive. Returns an empty list if the export has no uses directive.

Returns:
the names of the used packages.

getMandatory

java.util.List<java.lang.String> getMandatory()
Returns a list of the attribute names specified in the export's mandatory directive.

Returns:
the names of the mandatory attributes. Returns an empty list if the export has no mandatory directive.

getInclude

java.util.List<java.lang.String> getInclude()
Returns a list of the class names specified in the export's include directive. Returns an empty list if the export has no include directive.

Returns:
the list of inclusions

getExclude

java.util.List<java.lang.String> getExclude()
Returns a list of the class names specified in the export's exclude directive. Returns an empty list if the export has no exclude directive.

Returns:
the list of exclusions