Package aQute.bnd.service.reporter
Interface ReportTransformerPlugin
-
@ProviderType public interface ReportTransformerPlugin
This plugin transform an input model by applying a template on it.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]
getHandledModelExtensions()
Get the set of file extension names corresponding to the model format that this plugin support.java.lang.String[]
getHandledTemplateExtensions()
Get the set of file extension names corresponding to the template format that this plugin support.void
transform(java.io.InputStream model, java.io.InputStream template, java.io.OutputStream output, java.util.Map<java.lang.String,java.lang.String> parameters)
Transform the model by applying the template on it and write the result to the output stream.
-
-
-
Method Detail
-
getHandledTemplateExtensions
java.lang.String[] getHandledTemplateExtensions()
Get the set of file extension names corresponding to the template format that this plugin support.- Returns:
- one or multiple extensions name, never
null
-
getHandledModelExtensions
java.lang.String[] getHandledModelExtensions()
Get the set of file extension names corresponding to the model format that this plugin support.- Returns:
- one or multiple extensions name, never
null
-
transform
void transform(java.io.InputStream model, java.io.InputStream template, java.io.OutputStream output, java.util.Map<java.lang.String,java.lang.String> parameters) throws java.lang.Exception
Transform the model by applying the template on it and write the result to the output stream.- Parameters:
model
- an input stream that contains the model, must not benull
template
- an input stream that contains the template, must not benull
output
- the output stream to write the transformation result, must not benull
parameters
- a map of parameters and their value that must be provided to the template engine, must not benull
- Throws:
java.lang.Exception
- if any errors occur during the transformation process
-
-