net.sourceforge.javadpkg.plugin.ControlRecommendedFieldNotSetWarning 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 net.sourceforge.javadpkg.Warning;


/**
 * 
 * A warning about an recommended field which is not set in the control.
 * 
 *
 * @author Gerrit Hohl ([email protected])
 * @version 1.0, 03.05.2016 by Gerrit Hohl
 */
public class ControlRecommendedFieldNotSetWarning implements Warning {
	
	
	/** The field name. */
	private String fieldName;


	/**
	 * 
	 * Creates a warning.
	 * 
	 *
	 * @param fieldName
	 *            The field name.
	 * @throws IllegalArgumentException
	 *             If the field name is null.
	 */
	public ControlRecommendedFieldNotSetWarning(String fieldName) {
		super();
		
		if (fieldName == null)
			throw new IllegalArgumentException("Argument fieldName is null.");
		
		this.fieldName = fieldName;
	}
	
	
	@Override
	public String getText() {
		StringBuilder sb;
		
		
		sb = new StringBuilder();
		sb.append("Recommended field |");
		sb.append(this.fieldName);
		sb.append("| is not set in the configuration.");
		
		return sb.toString();
	}

}