Package org.apache.sling.feature

Class 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
    • Prototype
    • Extensions
    This class is not thread-safe.

    • 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 Map<String,​String> getFrameworkProperties()
        Get the framework properties The returned object is modifiable.
        Returns:
        The framework properties

      • getRequirements

        public List<MatchingRequirement> 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

      • getPrototype

        public Prototype getPrototype()
        Get the optional prototype feature.
        Returns:
        The prototype feature or null if none.

      • setPrototype

        public void setPrototype​(Prototype prototype)
        Set the optional prototype feature.
        Parameters:
        prototype - The prototype feature or null if none.

      • 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 Map<String,​String> 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

      • isFinal

        public boolean isFinal()
        Check whether the feature is final. A final feature can't be a prototype for other features.
        Returns:
        true if it is final, false otherwise

      • setFinal

        public void setFinal​(boolean flag)
        Set the final flag
        Parameters:
        flag - The flag

      • isComplete

        public boolean isComplete()
        Check whether the feature is complete. A complete feature has no external dependencies and can run as-is.
        Returns:
        true if it is complete, false otherwise

      • setComplete

        public void setComplete​(boolean flag)
        Set the complete flag
        Parameters:
        flag - The flag

      • 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 For contained items like bundles, artifacts and configurations a copy is created as well.
        Parameters:
        id - The new id
        Returns:
        The copy of the feature with the new id

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object