net.sourceforge.javadpkg.impl

Class CopyrightImpl

java.lang.Object

net.sourceforge.javadpkg.impl.CopyrightImpl

All Implemented Interfaces:

Copyright

public class CopyrightImpl
extends Object
implements Copyright

A Copyright implementation.

Version:

1.0, 06.05.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
CopyrightImpl() Creates a copyright.

Method Summary

Modifier and Type	Method and Description
void	addFilesCopyright(FilesCopyright filesCopyright) Adds the copyright for certain files of a Debian package.
void	addLicense(CopyrightLicense license) Adds a license to the licenses.
String	getComment() Returns the comment.
String	getCopyright() Returns the copyright.
String	getDisclaimer() Returns the disclaimer.
List<FilesCopyright>	getFilesCopyrights() Returns the copyrights for certain files of a Debian package.
String	getFormat() Returns the format of the copyright.
CopyrightLicense	getLicense() Returns the license.
Map<String,CopyrightLicense>	getLicenses() Returns the licenses referred by this copyright or one of copyrights for certain files.
String	getSource() Returns the source.
String	getUpstreamContact() Returns the upstream contact.
String	getUpstreamName() Returns the name upstream uses for the software.
void	setComment(String comment) Sets the comment.
void	setCopyright(String copyright) Sets the copyright.
void	setDisclaimer(String disclaimer) Sets the disclaimer.
void	setFilesCopyrights(List<FilesCopyright> filesCopyrights) Sets the copyrights for certain files of a Debian package.
void	setFormat(String format) Sets the format of the copyright.
void	setLicense(CopyrightLicense license) Sets the license.
void	setLicenses(Map<String,CopyrightLicense> licenses) Sets the licenses.
void	setSource(String source) Sets the source.
void	setUpstreamContact(String upstreamContact) Sets the upstream contact.
void	setUpstreamName(String upstreamName) Sets the name upstream uses for the software.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CopyrightImpl

public CopyrightImpl()

Creates a copyright.

Method Detail

getFormat

public String getFormat()

Description copied from interface: Copyright

Returns the format of the copyright.

A format is specified by an URI of the format specification.

Example:

http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Specified by:

getFormat in interface Copyright

Returns:

The format.

setFormat

public void setFormat(String format)

Sets the format of the copyright.

Parameters:

format - The format.

getUpstreamName

public String getUpstreamName()

Description copied from interface: Copyright

Returns the name upstream uses for the software.

Example:

SOFTware

Specified by:

getUpstreamName in interface Copyright

Returns:

The name or null, if no name is set.

setUpstreamName

public void setUpstreamName(String upstreamName)

Sets the name upstream uses for the software.

Parameters:

upstreamName - The name.

getUpstreamContact

public String getUpstreamContact()

Description copied from interface: Copyright

Returns the upstream contact.

The preferred address(es) to reach the upstream project. May be free-form text, but by convention will usually be written as a list of RFC5322 addresses or URIs.

Example:

John Doe <john.doe@example.com>

Specified by:

getUpstreamContact in interface Copyright

Returns:

The contact or null, if no contact is set.

setUpstreamContact

public void setUpstreamContact(String upstreamContact)

Sets the upstream contact.

Parameters:

upstreamContact - The contact.

getSource

public String getSource()

Description copied from interface: Copyright

Returns the source.

Formatted text, no synopsis: an explanation of where the upstream source came from. Typically this would be a URL, but it might be a free-form explanation.

Example:

http://www.example.com/software/project

Specified by:

getSource in interface Copyright

Returns:

The source or null, if no source is set.

setSource

public void setSource(String source)

Sets the source.

Parameters:

source - The source.

getDisclaimer

public String getDisclaimer()

Description copied from interface: Copyright

Returns the disclaimer.

Formatted text, no synopsis: this field is used for non-free or contrib packages to state that they are not part of Debian and to explain why.

Specified by:

getDisclaimer in interface Copyright

Returns:

The disclaimer or null, if no disclaimer is set.

setDisclaimer

public void setDisclaimer(String disclaimer)

Sets the disclaimer.

Parameters:

disclaimer - The disclaimer.

getComment

public String getComment()

Description copied from interface: Copyright

Returns the comment.

Formatted text, no synopsis: this field can provide additional information. For example, it might quote an e-mail from upstream justifying why the license is acceptable to the main archive, or an explanation of how this version of the package has been forked from a version known to be DFSG-free, even though the current upstream version is not.

Specified by:

getComment in interface Copyright

Returns:

The comment or null, if no comment is set.

setComment

public void setComment(String comment)

Sets the comment.

Parameters:

comment - The comment.

getLicense

public CopyrightLicense getLicense()

Description copied from interface: Copyright

Returns the license.

The returned license can be reference to one of the licenses returned by the Copyright.getLicenses() method.

Specified by:

getLicense in interface Copyright

Returns:

The license or null, if no license is set.

setLicense

public void setLicense(CopyrightLicense license)

Sets the license.

Parameters:

license - The license.

getCopyright

public String getCopyright()

Description copied from interface: Copyright

Returns the copyright.

Example:

Copyright 2008 John Smith
Copyright 2009 Angela Watts

Specified by:

getCopyright in interface Copyright

Returns:

The copyright or null, if no copyright is set.

setCopyright

public void setCopyright(String copyright)

Sets the copyright.

Parameters:

copyright - The copyright.

getFilesCopyrights

public List<FilesCopyright> getFilesCopyrights()

Description copied from interface: Copyright

Returns the copyrights for certain files of a Debian package.

Specified by:

getFilesCopyrights in interface Copyright

Returns:

The copyrights.

setFilesCopyrights

public void setFilesCopyrights(List<FilesCopyright> filesCopyrights)

Sets the copyrights for certain files of a Debian package.

Parameters:

filesCopyrights - The copyrights.

addFilesCopyright

public void addFilesCopyright(FilesCopyright filesCopyright)

Adds the copyright for certain files of a Debian package.

Parameters:

filesCopyright - The copyright.

Throws:

IllegalArgumentException - If the copyright is null.

getLicenses

public Map<String,CopyrightLicense> getLicenses()

Description copied from interface: Copyright

Returns the licenses referred by this copyright or one of copyrights for certain files.

Specified by:

getLicenses in interface Copyright

Returns:

The licenses.

See Also:

Copyright.getLicense(), Copyright.getFilesCopyrights(), FilesCopyright.getLicense()

setLicenses

public void setLicenses(Map<String,CopyrightLicense> licenses)

Sets the licenses.

Parameters:

licenses - The licenses.

addLicense

public void addLicense(CopyrightLicense license)

Adds a license to the licenses.

If a license with the same name already exists, then it will be replaced.

Parameters:

license - The license.

See Also:

setLicenses(Map)