org.apache.sling.feature

Class Feature

java.lang.Object

org.apache.sling.feature.Feature

All Implemented Interfaces:

Comparable<Feature>

public class Feature
extends Object
implements Comparable<Feature>

A feature consists of

• A unique id ArtifactId
• Bundles
• Configurations
• Framework properties
• Requirements and capabilities
• Includes
• Extensions

Constructor Summary

Constructors

Constructor and Description
Feature(ArtifactId id) Construct a new feature.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Feature o)
Feature	copy() Create a copy of the feature
Feature	copy(ArtifactId id) Create a copy of the feature with a different id
boolean	equals(Object obj)
Bundles	getBundles() Get the bundles.
List<org.osgi.resource.Capability>	getCapabilities() Get the list of capabilities.
Configurations	getConfigurations() Get the configurations.
String	getDescription() Get the description
Extensions	getExtensions() Get the list of extensions.
KeyValueMap	getFrameworkProperties() Get the framework properties The returned object is modifiable.
ArtifactId	getId() Get the id of the artifact.
List<Include>	getIncludes() Get the list of includes.
String	getLicense() Get the license
String	getLocation() Get the location.
List<org.osgi.resource.Requirement>	getRequirements() Get the list of requirements.
String	getTitle() Get the title
KeyValueMap	getVariables() Obtain the variables of the feature
String	getVendor() Get the vendor
int	hashCode()
boolean	isAssembled() Check whether the feature is already assembled
void	setAssembled(boolean flag) Set the assembled flag
void	setDescription(String description) Set the description
void	setLicense(String license) Set the vendor
void	setLocation(String value) Set the location.
void	setTitle(String title) Set the title
void	setVendor(String vendor) Set the vendor
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Feature

public Feature(ArtifactId id)

Construct a new feature.

Parameters:

id - The id of the feature.

Throws:

IllegalArgumentException - If id is null.

Method Detail

getId

public ArtifactId getId()

Get the id of the artifact.

Returns:

The id.

getLocation

public String getLocation()

Get the location. The location might be the location of the feature file or any other means identifying where the object is defined.

Returns:

The location or null.

setLocation

public void setLocation(String value)

Set the location.

Parameters:

value - The new location.

getBundles

public Bundles getBundles()

Get the bundles.

Returns:

The bundles object.

getConfigurations

public Configurations getConfigurations()

Get the configurations. The returned object is modifiable.

Returns:

The configurations

getFrameworkProperties

public KeyValueMap getFrameworkProperties()

Get the framework properties The returned object is modifiable.

Returns:

The framework properties

getRequirements

public List<org.osgi.resource.Requirement> getRequirements()

Get the list of requirements. The returned object is modifiable.

Returns:

The list of requirements

getCapabilities

public List<org.osgi.resource.Capability> getCapabilities()

Get the list of capabilities. The returned object is modifiable.

Returns:

The list of capabilities

getIncludes

public List<Include> getIncludes()

Get the list of includes. The returned object is modifiable.

Returns:

The list of includes

getExtensions

public Extensions getExtensions()

Get the list of extensions. The returned object is modifiable.

Returns:

The list of extensions

getTitle

public String getTitle()

Get the title

Returns:

The title or null

setTitle

public void setTitle(String title)

Set the title

Parameters:

title - The title

getDescription

public String getDescription()

Get the description

Returns:

The description or null

setDescription

public void setDescription(String description)

Set the description

Parameters:

description - The description

getVariables

public KeyValueMap getVariables()

Obtain the variables of the feature

Returns:

The variables

getVendor

public String getVendor()

Get the vendor

Returns:

The vendor or null

setVendor

public void setVendor(String vendor)

Set the vendor

Parameters:

vendor - The vendor

getLicense

public String getLicense()

Get the license

Returns:

The license or null

setLicense

public void setLicense(String license)

Set the vendor

Parameters:

license - The license

isAssembled

public boolean isAssembled()

Check whether the feature is already assembled

Returns:

true if it is assembled, false if it needs to be assembled

setAssembled

public void setAssembled(boolean flag)

Set the assembled flag

Parameters:

flag - The flag

copy

public Feature copy()

Create a copy of the feature

Returns:

A copy of the feature

copy

public Feature copy(ArtifactId id)

Create a copy of the feature with a different id

Parameters:

id - The new id

Returns:

The copy of the feature with the new id

compareTo

public int compareTo(Feature o)

Specified by:

compareTo in interface Comparable<Feature>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object