net.sourceforge.javadpkg.plugin.cfg.CopyrightConfiguration 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.cfg;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.apache.maven.plugins.annotations.Parameter;

/**
 * 
 * The copyright configuration.
 * 
 *
 * @author Gerrit Hohl ([email protected])
 * @version 1.0, 09.05.2016 by Gerrit Hohl
 */
public class CopyrightConfiguration {
	
	
	/** The file. */
	@Parameter(name = "file")
	private File								file;
	/** The name upstream uses for the software. */
	@Parameter(name = "upstreamName")
	private String								upstreamName;
	/** The upstream contact. */
	@Parameter(name = "upstreamContact")
	private String								upstreamContact;
	/** The source. */
	@Parameter(name = "source")
	private String								source;
	/** The disclaimer. */
	@Parameter(name = "disclaimer")
	private String								disclaimer;
	/** The comment. */
	@Parameter(name = "comment")
	private String								comment;
	/** The license configuration. */
	@Parameter(name = "license")
	private CopyrightLicenseConfiguration		license;
	/** The copyright. */
	@Parameter(name = "copyright")
	private String								copyright;
	/** The files copyright configurations. */
	@Parameter(name = "files")
	private List	files;
	/** The configurations of the licenses. */
	@Parameter(name = "licenses")
	private List	licenses;
	
	
	/**
	 * 
	 * Creates the configuration.
	 * 
	 */
	public CopyrightConfiguration() {
		super();
		
		this.file = null;
		this.upstreamName = null;
		this.upstreamContact = null;
		this.source = null;
		this.disclaimer = null;
		this.comment = null;
		this.license = null;
		this.copyright = null;
		this.files = new ArrayList<>();
		this.licenses = new ArrayList<>();
	}


	/**
	 * 
	 * Returns the file.
	 * 
	 *
	 * @return The file or null, if no file is set.
	 */
	public File getFile() {
		return this.file;
	}


	/**
	 * 
	 * Sets the file.
	 * 
	 *
	 * @param file
	 *            The file.
	 */
	public void setFile(File file) {
		this.file = file;
	}
	
	
	/**
	 * 
	 * Returns the name upstream uses for the software.
	 * 
	 *
	 * @return The name or null, if no name is set.
	 */
	public String getUpstreamName() {
		return this.upstreamName;
	}
	
	
	/**
	 * 
	 * Sets the name upstream uses for the software.
	 * 
	 *
	 * @param upstreamName
	 *            The name.
	 */
	public void setUpstreamName(String upstreamName) {
		this.upstreamName = upstreamName;
	}
	
	
	/**
	 * 
	 * Returns the upstream contact.
	 * 
	 *
	 * @return The upstream contact or null, if no upstream contact
	 *         is set.
	 */
	public String getUpstreamContact() {
		return this.upstreamContact;
	}
	
	
	/**
	 * 
	 * Sets the upstream contact.
	 * 
	 *
	 * @param upstreamContact
	 *            The upstream contact.
	 */
	public void setUpstreamContact(String upstreamContact) {
		this.upstreamContact = upstreamContact;
	}
	
	
	/**
	 * 
	 * Returns the source.
	 * 
	 *
	 * @return The source.
	 */
	public String getSource() {
		return this.source;
	}
	
	
	/**
	 * 
	 * Sets the source.
	 * 
	 *
	 * @param source
	 *            The source.
	 */
	public void setSource(String source) {
		this.source = source;
	}
	
	
	/**
	 * 
	 * Returns the disclaimer.
	 * 
	 *
	 * @return The disclaimer.
	 */
	public String getDisclaimer() {
		return this.disclaimer;
	}
	
	
	/**
	 * 
	 * Sets the disclaimer.
	 * 
	 *
	 * @param disclaimer
	 *            The disclaimer.
	 */
	public void setDisclaimer(String disclaimer) {
		this.disclaimer = disclaimer;
	}
	
	
	/**
	 * 
	 * Returns the comment.
	 * 
	 *
	 * @return The comment or null, if no comment is set.
	 */
	public String getComment() {
		return this.comment;
	}
	
	
	/**
	 * 
	 * Sets the comment.
	 * 
	 *
	 * @param comment
	 *            The comment.
	 */
	public void setComment(String comment) {
		this.comment = comment;
	}
	
	
	/**
	 * 
	 * Returns the license configuration.
	 * 
	 *
	 * @return The license configuration or null, if no license
	 *         configuration is set.
	 */
	public CopyrightLicenseConfiguration getLicense() {
		return this.license;
	}
	
	
	/**
	 * 
	 * Sets the license configuration.
	 * 
	 *
	 * @param license
	 *            The license configuration.
	 */
	public void setLicense(CopyrightLicenseConfiguration license) {
		this.license = license;
	}


	/**
	 * 
	 * Returns the copyright.
	 * 
	 * 
	 * @return The copyright or null, if no copyright is set.
	 */
	public String getCopyright() {
		return this.copyright;
	}


	/**
	 * 
	 * Sets the copyright.
	 * 
	 * 
	 * @param copyright
	 *            The copyright.
	 */
	public void setCopyright(String copyright) {
		this.copyright = copyright;
	}


	/**
	 * 
	 * Returns the files copyright configurations.
	 * 
	 *
	 * @return The files copyright configurations.
	 */
	public List getFiles() {
		return (new ArrayList<>(this.files));
	}
	
	
	/**
	 * 
	 * Sets the files copyright configurations.
	 * 
	 *
	 * @param files
	 *            The files copyright configurations.
	 */
	public void setFiles(List files) {
		if (files == null) {
			this.files = new ArrayList<>();
		} else {
			this.files = new ArrayList<>(files);
		}
	}
	
	
	/**
	 * 
	 * Returns the configurations of the licenses.
	 * 
	 *
	 * @return The configurations.
	 */
	public List getLicenses() {
		return (new ArrayList<>(this.licenses));
	}
	
	
	/**
	 * 
	 * Sets the configurations of the licenses.
	 * 
	 *
	 * @param licenses
	 *            The configurations.
	 */
	public void setLicenses(List licenses) {
		if (licenses == null) {
			this.licenses = new ArrayList<>();
		} else {
			this.licenses = new ArrayList<>(licenses);
		}
	}
	
	
}