Top Description Methods
org.osgi.service.feature

public Interface FeatureService

Annotations
@ProviderType
Imports
java.io.IOException, .Reader, .Writer, org.osgi.annotation.versioning.ProviderType
The Feature service is the primary entry point for interacting with the feature model.

Method Summary

Modifier and TypeMethod and Description
public BuilderFactory

Returns:

A builder factory.
getBuilderFactory()

Get a factory which can be used to build feature model entities.

public ID

Returns:

The ID.
getID(String
The group ID (not null, not empty).
groupId, String
The artifact ID (not null, not empty).
artifactId, String
The version (not null, not empty).
version)

Obtain an ID.

public ID

Returns:

The ID.
getID(String
The group ID (not null, not empty).
groupId, String
The artifact ID (not null, not empty).
artifactId, String
The version (not null, not empty).
version, String
The type (not null, not empty).
type)

Obtain an ID.

public ID

Returns:

The ID.
getID(String
The group ID (not null, not empty).
groupId, String
The artifact ID (not null, not empty).
artifactId, String
The version (not null, not empty).
version, String
The type (not null, not empty).
type, String
The classifier (not null, not empty).
classifier)

Obtain an ID.

public ID

Returns:

the ID.
getIDfromMavenCoordinates(String
The Maven Coordinates.
coordinates)

Obtain an ID from a Maven Coordinates formatted string.

public Feature

Returns:

The Feature represented by the JSON
readFeature(Reader
A Reader to the JSON input
jsonReader)

Read a Feature from JSON

public void
writeFeature(Feature
the Feature to write.
feature, Writer
A Writer to which the Feature should be written.
jsonWriter)

Write a Feature Model to JSON

Method Detail

getBuilderFactoryback to summary
public BuilderFactory getBuilderFactory()

Get a factory which can be used to build feature model entities.

Returns:BuilderFactory

A builder factory.

getIDback to summary
public ID getID(String groupId, String artifactId, String version)

Obtain an ID.

Parameters
groupId:String

The group ID (not null, not empty).

artifactId:String

The artifact ID (not null, not empty).

version:String

The version (not null, not empty).

Returns:ID

The ID.

getIDback to summary
public ID getID(String groupId, String artifactId, String version, String type)

Obtain an ID.

Parameters
groupId:String

The group ID (not null, not empty).

artifactId:String

The artifact ID (not null, not empty).

version:String

The version (not null, not empty).

type:String

The type (not null, not empty).

Returns:ID

The ID.

getIDback to summary
public ID getID(String groupId, String artifactId, String version, String type, String classifier)

Obtain an ID.

Parameters
groupId:String

The group ID (not null, not empty).

artifactId:String

The artifact ID (not null, not empty).

version:String

The version (not null, not empty).

type:String

The type (not null, not empty).

classifier:String

The classifier (not null, not empty).

Returns:ID

The ID.

getIDfromMavenCoordinatesback to summary
public ID getIDfromMavenCoordinates(String coordinates)

Obtain an ID from a Maven Coordinates formatted string. The supported syntax is as follows:

groupId ':' artifactId ( ':' type ( ':' classifier )? )? ':' version

Parameters
coordinates:String

The Maven Coordinates.

Returns:ID

the ID.

readFeatureback to summary
public Feature readFeature(Reader jsonReader) throws IOException

Read a Feature from JSON

Parameters
jsonReader:Reader

A Reader to the JSON input

Returns:Feature

The Feature represented by the JSON

Exceptions
IOException:
When reading fails
writeFeatureback to summary
public void writeFeature(Feature feature, Writer jsonWriter) throws IOException

Write a Feature Model to JSON

Parameters
feature:Feature

the Feature to write.

jsonWriter:Writer

A Writer to which the Feature should be written.

Exceptions
IOException:
When writing fails.