aQute.bnd.annotation.service.ServiceCapability Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biz.aQute.bndlib Show documentation

bndlib: A Swiss Army Knife for OSGi

The newest version!

package aQute.bnd.annotation.service;

import static aQute.bnd.annotation.spi.Constants.ATTRIBUTE_MACRO;

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;

import org.osgi.annotation.bundle.Capability;
import org.osgi.namespace.service.ServiceNamespace;
import org.osgi.resource.Namespace;;

/**
 * Adds a ProvideCapability for a service. This is useful to the resolver, when
 * a service is registered manually. It can annotate a class or a package. If it
 * annotates a class without specifying a value, the class will be named as the
 * registered service. Uses constraints will be calculated automatically.
 */
@Retention(RetentionPolicy.CLASS)
@Target({
	ElementType.TYPE, ElementType.PACKAGE
})
@Repeatable(ServiceCapabilities.class)
@Capability(namespace = ServiceNamespace.SERVICE_NAMESPACE, //
	attribute = {
		ServiceNamespace.CAPABILITY_OBJECTCLASS_ATTRIBUTE + ":List=\"${uniq;${#value}}\"", //
		Namespace.CAPABILITY_USES_DIRECTIVE
			+ ":=\"${if;${size;${#uses}};${#uses};${uniq;${replace;${#value};(.*)\\.[^.]+;$1}}}\"",
		ATTRIBUTE_MACRO
	})
public @interface ServiceCapability {
	/**
	 * The service type.
	 *
	 * @return the service type
	 */
	Class value() default Target.class;

	/**
	 * 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 {};

	/**
	 * 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
	 * {@code osgi.serviceloader} capability. Non-standard
	 * {@code osgi.serviceloader} attributes will be included as service
	 * properties to the published service.
	 */
	String[] attribute() default {};
}