Package biz.aQute.bnd.reporter.plugins.entries.bundle

Class ImportJarResourcePlugin

java.lang.Object

biz.aQute.bnd.reporter.plugins.entries.bundle.ImportJarResourcePlugin

All Implemented Interfaces:

Plugin, RegistryPlugin, ReportEntryPlugin<Jar>

public class ImportJarResourcePlugin
extends java.lang.Object
implements ReportEntryPlugin<Jar>, Plugin, RegistryPlugin

This plugin allows to add a file localized in a Jar to the report. The file will be converted into DTO. The PATH_PROPERTY property must be set and the TYPE_PROPERTY can be set if the file type is not obvious (derived from its extension).

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,java.lang.String>	_properties
private Registry	_registry
private Reporter	_reporter
static java.lang.String	PATH_PROPERTY
static java.lang.String	TYPE_PROPERTY

Fields inherited from interface aQute.bnd.service.reporter.ReportEntryPlugin

ENTRY_NAME_PROPERTY, SOURCE_CLASS_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ImportJarResourcePlugin()

Method Summary

Modifier and Type	Method	Description
private java.lang.Object	convertFile(java.io.InputStream inputStream, java.lang.String extension)
java.lang.Object	extract(Jar source, java.util.Locale locale)	Extracts a piece of information from the source in arguments.
private java.lang.String[]	getAvailableConverterExtensions()
private java.lang.String	getPath()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
private java.lang.String	getType()
private java.io.InputStream	resolveFile(Jar source)
void	setProperties(java.util.Map<java.lang.String,java.lang.String> map)	Give the plugin the remaining properties.
void	setRegistry(Registry registry)
void	setReporter(Reporter processor)	Set the current reporter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATH_PROPERTY

public static final java.lang.String PATH_PROPERTY

See Also:

Constant Field Values

TYPE_PROPERTY

public static final java.lang.String TYPE_PROPERTY

See Also:

Constant Field Values

_reporter

private Reporter _reporter

_registry

private Registry _registry

_properties

private final java.util.Map<java.lang.String,java.lang.String> _properties

Constructor Detail

ImportJarResourcePlugin

public ImportJarResourcePlugin()

Method Detail

extract

public java.lang.Object extract(Jar source,
                                java.util.Locale locale)
                         throws java.lang.Exception

Description copied from interface: ReportEntryPlugin

Extracts a piece of information from the source in arguments.

If the source contains localized data, it will be extracted for the specified locale or a less specific if not found.

Specified by:

extract in interface ReportEntryPlugin<Jar>

Parameters:

source - the source to inspect, must not be null

locale - the String representation of a Locale, must not be null

Returns:

a DTO representation or null if no data is available

Throws:

java.lang.Exception

resolveFile

private java.io.InputStream resolveFile(Jar source)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

convertFile

private java.lang.Object convertFile(java.io.InputStream inputStream,
                                     java.lang.String extension)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getAvailableConverterExtensions

private java.lang.String[] getAvailableConverterExtensions()

getPath

private java.lang.String getPath()

getType

private java.lang.String getType()

setRegistry

public void setRegistry(Registry registry)

Specified by:

setRegistry in interface RegistryPlugin

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> map)
                   throws java.lang.Exception

Description copied from interface: Plugin

Give the plugin the remaining properties. When a plugin is declared, the clause can contain extra properties. All the properties and directives are given to the plugin to use.

Specified by:

setProperties in interface Plugin

Parameters:

map - attributes and directives for this plugin's clause

Throws:

java.lang.Exception

setReporter

public void setReporter(Reporter processor)

Description copied from interface: Plugin

Set the current reporter. This is called at init time. This plugin should report all errors and warnings to this reporter.

Specified by:

setReporter in interface Plugin

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Specified by:

getProperties in interface ReportEntryPlugin<Jar>

Returns:

a map of properties, never null