A Feature Model Extension. Extensions can contain either Text, JSON or a list of Artifacts.

Extensions are of one of the following kinds:

Mandatory: this extension must be processed by the runtime
Optional: this extension does not have to be processed by the runtime
Transient: this extension contains transient information such as caching data that is for optimization purposes. It may be changed or removed and is not part of the feature's identity.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	FeatureExtension.Kind The kind of extension: optional, mandatory or transient.
public static enum	FeatureExtension.Type The type of extension

Method Summary

Modifier and Type	Method and Description
public List<FeatureArtifact>	Returns: The Artifacts. The returned list is unmodifiable. getArtifacts() Get the Artifacts from this extension.
public String	Returns: The JSON. getJSON() Get the JSON from this extension.
public FeatureExtension.Kind	Returns: The kind. getKind() Get the extension kind.
public String	Returns: The name. getName() Get the extension name.
public List<String>	Returns: The lines of text. The returned list is unmodifiable. getText() Get the Text from this extension.
public FeatureExtension.Type	Returns: The type. getType() Get the extension type.

Method Detail

getArtifacts	back to summary
public List<FeatureArtifact> getArtifacts() Get the Artifacts from this extension. Returns:List<FeatureArtifact> The Artifacts. The returned list is unmodifiable. Exceptions IllegalStateException: If called on an extension which is not of type ARTIFACTS.

getArtifacts

back to summary

public List<FeatureArtifact> getArtifacts()

Get the Artifacts from this extension.

Returns:List<FeatureArtifact>

The Artifacts. The returned list is unmodifiable.

Exceptions

IllegalStateException:: If called on an extension which is not of type ARTIFACTS.

getJSON	back to summary
public String getJSON() Get the JSON from this extension. Returns:String The JSON. Exceptions IllegalStateException: If called on an extension which is not of type JSON.

getJSON

back to summary

public String getJSON()

Get the JSON from this extension.

Returns:String

The JSON.

Exceptions

IllegalStateException:: If called on an extension which is not of type JSON.

getKind	back to summary
public FeatureExtension.Kind getKind() Get the extension kind. Returns:FeatureExtension.Kind The kind.

getKind

back to summary

public FeatureExtension.Kind getKind()

Get the extension kind.

Returns:FeatureExtension.Kind: The kind.

getName	back to summary
public String getName() Get the extension name. Returns:String The name.

getName

back to summary

public String getName()

Get the extension name.

Returns:String: The name.

getText	back to summary
public List<String> getText() Get the Text from this extension. Returns:List<String> The lines of text. The returned list is unmodifiable. Exceptions IllegalStateException: If called on an extension which is not of type TEXT.

getText

back to summary

public List<String> getText()

Get the Text from this extension.

Returns:List<String>

The lines of text. The returned list is unmodifiable.

Exceptions

IllegalStateException:: If called on an extension which is not of type TEXT.

getType	back to summary
public FeatureExtension.Type getType() Get the extension type. Returns:FeatureExtension.Type The type.

getType

back to summary

public FeatureExtension.Type getType()

Get the extension type.

Returns:FeatureExtension.Type: The type.

org.osgi.service.feature back to summary

public final Enum FeatureExtension.Kind

Class Inheritance

extends Enum<FeatureExtension.Kind>

java.lang.Object
java.lang.Enum
org.osgi.service.feature.FeatureExtension.Kind

The kind of extension: optional, mandatory or transient.

Field Summary

Modifier and Type	Field and Description
public static final FeatureExtension.Kind	MANDATORY A mandatory extension must be processed.
public static final FeatureExtension.Kind	OPTIONAL An optional extension can be ignored if no processor is found.
public static final FeatureExtension.Kind	TRANSIENT A transient extension contains computed information which can be used as a cache to speed up operation.

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static FeatureExtension.Kind	valueOf(String name)
public static FeatureExtension.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

MANDATORY	back to summary
public static final FeatureExtension.Kind MANDATORY A mandatory extension must be processed.

OPTIONAL	back to summary
public static final FeatureExtension.Kind OPTIONAL An optional extension can be ignored if no processor is found.

TRANSIENT	back to summary
public static final FeatureExtension.Kind TRANSIENT A transient extension contains computed information which can be used as a cache to speed up operation.

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

valueOf	back to summary
public static FeatureExtension.Kind valueOf(String name)

values	back to summary
public static FeatureExtension.Kind[] values()

org.osgi.service.feature back to summary

public final Enum FeatureExtension.Type

Class Inheritance

extends Enum<FeatureExtension.Type>

java.lang.Object
java.lang.Enum
org.osgi.service.feature.FeatureExtension.Type

The type of extension

Field Summary

Modifier and Type	Field and Description
public static final FeatureExtension.Type	ARTIFACTS An extension that is a list of artifact identifiers.
public static final FeatureExtension.Type	JSON A JSON extension.
public static final FeatureExtension.Type	TEXT A plain text extension.

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static FeatureExtension.Type	valueOf(String name)
public static FeatureExtension.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ARTIFACTS	back to summary
public static final FeatureExtension.Type ARTIFACTS An extension that is a list of artifact identifiers.

JSON	back to summary
public static final FeatureExtension.Type JSON A JSON extension.

TEXT	back to summary
public static final FeatureExtension.Type TEXT A plain text extension.

Constructor Detail

Type	back to summary
private Type()

Method Detail

valueOf	back to summary
public static FeatureExtension.Type valueOf(String name)

values	back to summary
public static FeatureExtension.Type[] values()

public Interface FeatureExtension

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum FeatureExtension.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FeatureExtension.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail