Top Description Methods
org.osgi.service.feature

public Interface BuilderFactory

Annotations
@ProviderType
Imports
org.osgi.annotation.versioning.ProviderType

The Builder Factory can be used to obtain builders for the various entities.

Method Summary

Modifier and TypeMethod and Description
public FeatureArtifactBuilder

Returns:

The builder.
newArtifactBuilder
(ID
The artifact ID for the artifact object being built.
id
)

Obtain a new builder for Artifact objects.

public FeatureBundleBuilder

Returns:

The builder.
newBundleBuilder
(ID
The ID for the bundle object being built. If the ID has no type specified, a default type of @{code jar} is assumed.
id
)

Obtain a new builder for Bundle objects.

public FeatureConfigurationBuilder

Returns:

The builder.
newConfigurationBuilder
(String
The persistent ID for the Configuration being built.
pid
)

Obtain a new builder for Configuration objects.

public FeatureConfigurationBuilder

Returns:

The builder.
newConfigurationBuilder
(String
The factory persistent ID for the Configuration being built.
factoryPid
,
String
The name of the configuration being built. The PID for the configuration will be the factoryPid + '~' + name
name
)

Obtain a new builder for Factory Configuration objects.

public FeatureExtensionBuilder

Returns:

The builder.
newExtensionBuilder
(String
The extension name.
name
,
FeatureExtension.Type
The type of extension: JSON, Text or Artifacts.
type
,
FeatureExtension.Kind
The kind of extension: Mandatory, Optional or Transient.
kind
)

Obtain a new builder for Feature objects.

public FeatureBuilder

Returns:

The builder.
newFeatureBuilder
(ID
The ID for the feature object being built. If the ID has no type specified, a default type of osgifeature is assumed.
id
)

Obtain a new builder for Feature objects.

Method Detail

newArtifactBuilderback to summary
public FeatureArtifactBuilder newArtifactBuilder(ID id)

Obtain a new builder for Artifact objects.

Parameters
id:ID

The artifact ID for the artifact object being built.

Returns:FeatureArtifactBuilder

The builder.

newBundleBuilderback to summary
public FeatureBundleBuilder newBundleBuilder(ID id)

Obtain a new builder for Bundle objects.

Parameters
id:ID

The ID for the bundle object being built. If the ID has no type specified, a default type of @{code jar} is assumed.

Returns:FeatureBundleBuilder

The builder.

newConfigurationBuilderback to summary
public FeatureConfigurationBuilder newConfigurationBuilder(String pid)

Obtain a new builder for Configuration objects.

Parameters
pid:String

The persistent ID for the Configuration being built.

Returns:FeatureConfigurationBuilder

The builder.

newConfigurationBuilderback to summary
public FeatureConfigurationBuilder newConfigurationBuilder(String factoryPid, String name)

Obtain a new builder for Factory Configuration objects.

Parameters
factoryPid:String

The factory persistent ID for the Configuration being built.

name:String

The name of the configuration being built. The PID for the configuration will be the factoryPid + '~' + name

Returns:FeatureConfigurationBuilder

The builder.

newExtensionBuilderback to summary
public FeatureExtensionBuilder newExtensionBuilder(String name, FeatureExtension.Type type, FeatureExtension.Kind kind)

Obtain a new builder for Feature objects.

Parameters
name:String

The extension name.

type:FeatureExtension.Type

The type of extension: JSON, Text or Artifacts.

kind:FeatureExtension.Kind

The kind of extension: Mandatory, Optional or Transient.

Returns:FeatureExtensionBuilder

The builder.

newFeatureBuilderback to summary
public FeatureBuilder newFeatureBuilder(ID id)

Obtain a new builder for Feature objects.

Parameters
id:ID

The ID for the feature object being built. If the ID has no type specified, a default type of osgifeature is assumed.

Returns:FeatureBuilder

The builder.