org.osgi.service.feature

Interface BuilderFactory

@ProviderType
public interface BuilderFactory

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

Method Summary

Modifier and Type	Method and Description
FeatureArtifactBuilder	newArtifactBuilder(ID id) Obtain a new builder for Artifact objects.
FeatureBundleBuilder	newBundleBuilder(ID id) Obtain a new builder for Bundle objects.
FeatureConfigurationBuilder	newConfigurationBuilder(String pid) Obtain a new builder for Configuration objects.
FeatureConfigurationBuilder	newConfigurationBuilder(String factoryPid, String name) Obtain a new builder for Factory Configuration objects.
FeatureExtensionBuilder	newExtensionBuilder(String name, FeatureExtension.Type type, FeatureExtension.Kind kind) Obtain a new builder for Feature objects.
FeatureBuilder	newFeatureBuilder(ID id) Obtain a new builder for Feature objects.

Method Detail

newArtifactBuilder

FeatureArtifactBuilder newArtifactBuilder(ID id)

Obtain a new builder for Artifact objects.

Parameters:

id - The artifact ID for the artifact object being built.

Returns:

The builder.

newBundleBuilder

FeatureBundleBuilder newBundleBuilder(ID id)

Obtain a new builder for Bundle objects.

Parameters:

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:

The builder.

newConfigurationBuilder

FeatureConfigurationBuilder newConfigurationBuilder(String pid)

Obtain a new builder for Configuration objects.

Parameters:

pid - The persistent ID for the Configuration being built.

Returns:

The builder.

newConfigurationBuilder

FeatureConfigurationBuilder newConfigurationBuilder(String factoryPid,
                                                    String name)

Obtain a new builder for Factory Configuration objects.

Parameters:

factoryPid - The factory persistent ID for the Configuration being built.

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

Returns:

The builder.

newFeatureBuilder

FeatureBuilder newFeatureBuilder(ID id)

Obtain a new builder for Feature objects.

Parameters:

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

Returns:

The builder.

newExtensionBuilder

FeatureExtensionBuilder newExtensionBuilder(String name,
                                            FeatureExtension.Type type,
                                            FeatureExtension.Kind kind)

Obtain a new builder for Feature objects.

Parameters:

name - The extension name.

type - The type of extension: JSON, Text or Artifacts.

kind - The kind of extension: Mandatory, Optional or Transient.

Returns:

The builder.