Interface IProvidedCapability


  • public interface IProvidedCapability
    Describes a capability that is exposed by an installable unit. These capabilities can satisfy the dependencies of other installable units, causing the unit providing the dependency to be installed.

    Instances of this class are handle objects and do not necessarily reflect entities that exist in any particular profile or repository. These handle objects can be created using MetadataFactory.

    Since:
    2.0
    See Also:
    IRequirement
    Restriction:
    This interface is not intended to be implemented by clients.
    Restriction:
    This interface is not intended to be extended by clients.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROPERTY_VERSION
      The name of the property under which the capability version is stored.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)
      Returns whether this provided capability is equal to the given object.
      java.lang.String getName()  
      java.lang.String getNamespace()  
      java.util.Map<java.lang.String,​java.lang.Object> getProperties()
      A full description of this capability including the name and the version.
      Version getVersion()  
    • Field Detail

      • PROPERTY_VERSION

        static final java.lang.String PROPERTY_VERSION
        The name of the property under which the capability version is stored. Can be used with getProperties(). The same value can be obtained with getVersion()
        Since:
        2.4
        See Also:
        Constant Field Values
    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
        Returns:
        String the namespace of this capability.
        Restriction:
        This method is not intended to be referenced by clients.
      • getName

        java.lang.String getName()
        Returns:
        String the attribute stored under a key equal to the getNamespace() attribute of this capability.
        Restriction:
        This method is not intended to be referenced by clients.
      • getVersion

        Version getVersion()
        Returns:
        String the special PROPERTY_VERSION attribute of this capability.
        Restriction:
        This method is not intended to be referenced by clients.
      • getProperties

        java.util.Map<java.lang.String,​java.lang.Object> getProperties()
        A full description of this capability including the name and the version.

        Such a description can be used to match this capability with an LDAP filter for example.

        Returns:
        An unmodifiable map
        Since:
        2.4
        Restriction:
        This method is not intended to be referenced by clients.
      • equals

        boolean equals​(java.lang.Object other)
        Returns whether this provided capability is equal to the given object. This method returns true if:
        • Both this object and the given object are of type IProvidedCapability
        • The result of getNamespace() on both objects are equal
        • The result of getProperties() on both objects are equal
        Overrides:
        equals in class java.lang.Object