• Home
• biz.aQute.bnd
• biz.aQute.bndlib
• 7.1.0
• source code
• ReportExporterService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

aQute.bnd.service.reporter.ReportExporterService Maven / Gradle / Ivy

package aQute.bnd.service.reporter;

import java.util.List;
import java.util.Map;

import org.osgi.annotation.versioning.ProviderType;

import aQute.bnd.osgi.Resource;

/**
 * This plugin can export a report generated by the
 * {@link ReportGeneratorService} service. The exported report can be serialized
 * into a specific format and optionally be transformed by a template engine.
 * 

 * The service can be extended by implementing the
 * {@link aQute.bnd.service.reporter.ReportSerializerPlugin} and the
 * {@link aQute.bnd.service.reporter.ReportTransformerPlugin} interfaces
 * respectively to support additional serialization format and additional
 * template engine.
 */
@ProviderType
public interface ReportExporterService {

	/**
	 * @param source the targeted source object to report, may be {@code null}
	 * @return the list of report destination file paths which can be extracted,
	 *         never {@code null}
	 */
	List getAvailableReportsOf(Object source);

	/**
	 * Export the reports of the specified source object.
	 *
	 * @param source the source object to report, may be {@code null}
	 * @return a map whose key are the user defined destination file path and
	 *         value are the resulting report resource, never {@code null}
	 */
	Map exportReportsOf(Object source);
}