Mark a package to be exported from its bundle.

The package must also be annotation with the Version annotation to specify the export version of the package.

This annotation is not retained at runtime. It is for use by tools to generate bundle manifests or otherwise process the package.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Export.Substitution Substitution policy for this package.

Method Summary

Modifier and Type	Method and Description
public String[]	attribute() A list of attribute or directive names and values.
public String	substitution() Specify the policy for substitutably importing this package.
public String[]	uses() A list of package names that are used by this package.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

attribute back to summary

attribute	back to summary
public String[] attribute() A list of attribute or directive names and values. Each string should be specified in the form: `"name=value"` for attributes. `"name:type=value"` for typed attributes. `"name:=value"` for directives. These are added, separated by semicolons, to the export package clause.

public String[] attribute()

A list of attribute or directive names and values.

Each string should be specified in the form:

"name=value" for attributes.
"name:type=value" for typed attributes.
"name:=value" for directives.

These are added, separated by semicolons, to the export package clause.

substitution back to summary

substitution	back to summary
public String substitution() Specify the policy for substitutably importing this package. Bundles that collaborate require the same class loader for types used in the collaboration. If multiple bundles export packages with collaboration types then they will have to be placed in disjoint class spaces, making collaboration impossible. Collaboration is significantly improved when bundles are willing to import exported packages; these imports will allow a framework to substitute exports for imports. If not specified, the `Substitution#CALCULATED` substitution policy is used for this package.

public String substitution()

Specify the policy for substitutably importing this package.

Bundles that collaborate require the same class loader for types used in the collaboration. If multiple bundles export packages with collaboration types then they will have to be placed in disjoint class spaces, making collaboration impossible. Collaboration is significantly improved when bundles are willing to import exported packages; these imports will allow a framework to substitute exports for imports.

If not specified, the Substitution#CALCULATED substitution policy is used for this package.

uses back to summary

uses	back to summary
public String[] uses() A list of package names that are used by this package. If the `uses` directive must be omitted from the export package clause for this package, the empty value `{}` must be specified. If not specified, the `uses` directive for the export package clause is calculated by inspection of the classes in this package.

public String[] uses()

A list of package names that are used by this package.

If the uses directive must be omitted from the export package clause for this package, the empty value {} must be specified.

If not specified, the uses directive for the export package clause is calculated by inspection of the classes in this package.

org.osgi.annotation.bundle back to summary

public final Class Export.Substitution

Class Inheritance

extends Object

java.lang.Object
org.osgi.annotation.bundle.Export.Substitution

Substitution policy for this package.

Field Summary

Modifier and Type	Field and Description
public static final String	CALCULATED The policy value is calculated by inspection of the classes in the package.
public static final String	CONSUMER Use a consumer type version range for the import package clause when substitutably importing a package.
public static final String	NOIMPORT The package must not be substitutably imported.
public static final String	PROVIDER Use a provider type version range for the import package clause when substitutably importing a package.

Constructor Summary

Access	Constructor and Description
private	Substitution()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CALCULATED	back to summary
public static final String CALCULATED The policy value is calculated by inspection of the classes in the package.

CONSUMER back to summary

CONSUMER	back to summary
public static final String CONSUMER Use a consumer type version range for the import package clause when substitutably importing a package. See Also `ConsumerType`

public static final String CONSUMER

Use a consumer type version range for the import package clause when substitutably importing a package.

See Also: ConsumerType

NOIMPORT	back to summary
public static final String NOIMPORT The package must not be substitutably imported.

PROVIDER back to summary

PROVIDER	back to summary
public static final String PROVIDER Use a provider type version range for the import package clause when substitutably importing a package. See Also `ProviderType`

public static final String PROVIDER

Use a provider type version range for the import package clause when substitutably importing a package.

See Also: ProviderType

Constructor Detail

Substitution	back to summary
private Substitution()

public @Interface Export

Nested and Inner Type Summary

Method Summary

Method Detail

public final Class Export.Substitution

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail