org.apache.maven.doxia
Interface Converter

All Superinterfaces:

org.apache.maven.doxia.logging.LogEnabled

All Known Implementing Classes:

DefaultConverter

public interface Converter
extends org.apache.maven.doxia.logging.LogEnabled

Interface to convert a Doxia input wrapper to a Doxia output wrapper.

Version:

$Id: Converter.java 712860 2008-11-10 22:54:37Z hboutemy $

Author:

Vincent Siveton

Method Summary

void	convert(InputFileWrapper input, OutputFileWrapper output)
void	convert(InputReaderWrapper input, OutputStreamWrapper output)
String[]	getInputFormats()
String[]	getOutputFormats()
void	setFormatOutput(boolean formatOutput) Make the generated files human readable.

Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled

enableLogging

Method Detail

getInputFormats

String[] getInputFormats()

Returns:

a not null array containing supported input formats, i.e. apt.

getOutputFormats

String[] getOutputFormats()

Returns:

a not null array containing supported output formats, i.e. xhtml.

convert

void convert(InputFileWrapper input,
             OutputFileWrapper output)
             throws UnsupportedFormatException,
                    ConverterException

Parameters:

input - an input file wrapper, not null.

output - an output file wrapper, not null.

Throws:

UnsupportedFormatException - if any

ConverterException - if any

convert

void convert(InputReaderWrapper input,
             OutputStreamWrapper output)
             throws UnsupportedFormatException,
                    ConverterException

Parameters:

input - an input reader wrapper, not null.

output - an output writer wrapper, not null.

Throws:

UnsupportedFormatException - if any

ConverterException - if any

setFormatOutput

void setFormatOutput(boolean formatOutput)

Make the generated files human readable.
Note: actually, only XML based outputs could be formatted.

Parameters:

formatOutput - true to format the generated files, false otherwise.