net.sourceforge.javadpkg.plugin.ChangeLogConfigurationParser Maven / Gradle / Ivy

Go to download

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

The plugin for creating Debian Packages during a Maven build process.

The newest version!

/*
 * 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.plugin;

import java.io.IOException;

import org.apache.maven.plugin.logging.Log;

import net.sourceforge.javadpkg.ChangeLog;
import net.sourceforge.javadpkg.Context;
import net.sourceforge.javadpkg.ParseException;
import net.sourceforge.javadpkg.plugin.cfg.ChangeLogConfiguration;

/**
 * 
 * A parser for the change log configuration.
 * 
 *
 * @author Gerrit Hohl ([email protected])
 * @version 1.0, 09.05.2016 by Gerrit Hohl
 */
public interface ChangeLogConfigurationParser {
	
	
	/**
	 * 
	 * Parses the change log from the specified configuration.
	 * 
	 * 
	 * @param log
	 *            The log.
	 * @param config
	 *            The configuration.
	 * @return The change log.
	 * @param context
	 *            The context.
	 * @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 parseChangeLogConfiguration(Log log, ChangeLogConfiguration config, Context context)
			throws IOException, ParseException;


}