package org.apache.maven.javadoc;

import java.io.PrintWriter;
import java.util.Map;

/**
 * @author Steven Caswell
 */
public interface XmlBuilder
{
  /**
   * Returns the verbose setting.
   *
   * @return Returns the verbose setting.
   */
    public boolean isVerbose();

    /**
     * Returns the output encoding.
     *
     * @return the output encoding
     */
    public String getOutputEncoding();
  
    /**
     * Sets the output encoding.
     *
     * @param outputEncodingValue the output encoding
     */
    public void setOutputEncoding(String outputEncoding);
  
    /**
     * Sets the verbose mode.
     *
     * @param verboseValue the verbose mode.
     */
    public void setVerbose(boolean verbose);

    /**
     * Build a Map from the javadoc report lines.
     * @param input the lines
     * @return the Map of files with javadoc errors.
     */
    public Map buildMap(final String[] input);

    /**
     * Write the file map on the output
     * @param fileMap The filemap to translate in XML.
     * @param out The output to write.
     */
    public void writeOutput(Map fileMap, PrintWriter out);
}