net.sourceforge.javadpkg.ChangeLogParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dpkg Show documentation

The library for reading and writing Debian Packages.

There is a newer version: 1.0.5

/*
 * dpkg - Debian Package library and the Debian Package Maven plugin
 * (c) Copyright 2016 Gerrit Hohl
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package net.sourceforge.javadpkg;

import java.io.IOException;

import net.sourceforge.javadpkg.io.DataSource;

/**
 * 
 * A parser for the change log of a Debian package.
 * 
 *
 * @author Gerrit Hohl ([email protected])
 * @version 1.0, 04.05.2016 by Gerrit Hohl
 */
public interface ChangeLogParser {
	
	
	/**
	 * 
	 * Parses the change log from the specified source.
	 * 
	 *
	 * @param source
	 *            The source.
	 * @param context
	 *            The context.
	 * @return The change log.
	 * @throws IllegalArgumentException
	 *             If any of the parameters are null.
	 * @throws IOException
	 *             If an I/O error occurs.
	 * @throws ParseException
	 *             If an error occurs during the parsing.
	 */
	ChangeLog parseChangeLog(DataSource source, Context context) throws IOException, ParseException;


	/**
	 * 
	 * Parses the change log from the specified source as HTML.
	 * 
	 *
	 * @param source
	 *            The source.
	 * @param context
	 *            The context.
	 * @return The change log.
	 * @throws IllegalArgumentException
	 *             If any of the parameters are null.
	 * @throws IOException
	 *             If an I/O error occurs.
	 * @throws ParseException
	 *             If an error occurs during the parsing.
	 */
	ChangeLog parseChangeLogHtml(DataSource source, Context context) throws IOException, ParseException;
	
	
}