org.osgi.annotation.bundle.Capability Maven / Gradle / Ivy
/*
* Copyright (c) OSGi Alliance (2016, 2018). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.osgi.annotation.bundle;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Define a capability for a bundle.
*
* For example:
*
*
* @Capability(namespace=ExtenderNamespace.EXTENDER_NAMESPACE,
* name="osgi.component", version="1.3.0")
*
*
* This annotation is not retained at runtime. It is for use by tools to
* generate bundle manifests or otherwise process the type or package.
*
* This annotation can be used to annotate an annotation. If the meta-annotated
* annotation declares an element of the same name as an element in this
* annotation, the element is considered to override the element in this
* annotation.
*
* @author $Id: bf3cb5ae29bf95f25c8e217e3807c232b1ffb96c $
*/
@Documented
@Retention(RetentionPolicy.CLASS)
@Target({
ElementType.TYPE, ElementType.PACKAGE
})
@Repeatable(Capabilities.class)
public @interface Capability {
/**
* The namespace of this capability.
*/
String namespace();
/**
* The name of this capability within the namespace.
*
* If specified, adds an attribute with the name of the namespace and the
* value of the specified name to the capability clause.
*/
String name() default "";
/**
* The version of this capability.
*
* If specified, adds an attribute with the name and type of
* {@code version:Version} and the value of the specified version to the
* capability clause.
*
* The specified version must be a valid OSGi version string.
*/
String version() default "";
/**
* A list of classes whose packages are inspected to calculate the
* {@code uses} directive for this capability.
*
* If not specified, the {@code uses} directive is omitted from the
* capability clause.
*/
Class< ? >[] uses() default {};
/**
* The effective time of this capability.
*
* Specifies the time the capability is available. The OSGi framework
* resolver only considers capabilities without an effective directive or
* effective:=resolve. Capabilities with other values for the effective
* directive can be considered by an external agent.
*
* If not specified, the {@code effective} directive is omitted from the
* capability clause.
*/
String effective() default "resolve"; // Namespace.EFFECTIVE_RESOLVE
/**
* A list of attribute or directive names and values.
*
* Each string should be specified in the form:
*
* - {@code "name=value"} for attributes.
* - {@code "name:type=value"} for typed attributes.
* - {@code "name:=value"} for directives.
*
* These are added, separated by semicolons, to the export package clause.
*/
String[] attribute() default {};
}