org.wso2.maven.p2.feature.generate

Class Feature

java.lang.Object

org.wso2.maven.p2.beans.CarbonArtifact

org.wso2.maven.p2.feature.generate.Feature

public class Feature
extends CarbonArtifact

Bean class representing a Feature object provided as an input param to FeatureGenMojo.

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
Feature()

Method Summary

Modifier and Type	Method and Description
String	getFeatureVersion() Returns the Feature version in OSGI format.
String	getId() Returns the feature id represented by this Feature.
boolean	isOptional() Returns whether this particular feature is optional or not.
void	setId(String id) Sets the feature version for the given feature.
void	setOptional(boolean optional) Sets whether this feature is optional or not.

Methods inherited from class org.wso2.maven.p2.beans.CarbonArtifact

copyTo, getArtifact, getArtifactId, getBundleVersion, getCompatibility, getGroupId, getSymbolicName, getType, getVersion, setArtifact, setArtifactId, setBundleVersion, setCompatibility, setGroupId, setSymbolicName, setType, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Feature

public Feature()

Method Detail

getId

public String getId()

Returns the feature id represented by this Feature.

If the name of the feature id ends with '.feature', then '.feature' word is removed and the result is returned.

Returns:

String feature id.

setId

public void setId(String id)

Sets the feature version for the given feature.

Parameters:

id - String

isOptional

public boolean isOptional()

Returns whether this particular feature is optional or not. This is considered when generating the feature.xml

Returns:

true if this feature is optional

setOptional

public void setOptional(boolean optional)

Sets whether this feature is optional or not. This is applicable only to included features.

Note: There is no usage of this method in the plugin code. However, this is used by plexus container to inject the value.

Parameters:

optional - boolean

getFeatureVersion

public String getFeatureVersion()

Returns the Feature version in OSGI format.

i.e: If the maven version for this artifact is 4.2.0-SNAPSHOT, this will return 4.2.0.SNAPSHOT

Returns:

String