org.daisy.dotify.api.obfl.ObflParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dotify.library Show documentation

Dotify Library

There is a newer version: 1.0.7

package org.daisy.dotify.api.obfl;

import org.daisy.dotify.api.formatter.Formatter;
import org.daisy.dotify.api.formatter.FormatterException;
import org.daisy.dotify.api.writer.MetaDataItem;

import java.util.List;
import javax.xml.stream.XMLEventReader;


/**
 * Provides an OBFL-parser. The parser reads an OBFL-file and places
 * its contents in a formatter instance.
 *
 * @author Joel Håkansson
 */
public interface ObflParser {

    /**
     * Parses the input places its contents in the supplied formatter.
     *
     * @param input     the OBFL
     * @param formatter the formatter
     * @throws FormatterException  if there is a problem writing contents to the formatter
     * @throws ObflParserException if there is a problem reading the OBFL
     */
    public void parse(XMLEventReader input, Formatter formatter) throws FormatterException, ObflParserException;

    /**
     * Gets a list of meta data items collected by the latest call to {@link #parse(XMLEventReader, Formatter)}.
     *
     * @return returns a list of meta data items
     */
    public List getMetaData();
}