net.sourceforge.javadpkg

Interface Copyright

All Known Implementing Classes:

CopyrightImpl

public interface Copyright

The copyright of a Debian package.

Version:

1.0, 04.05.2016 by Gerrit Hohl

Author:

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

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getFormat

String getFormat()

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/

Returns:

The format.

getUpstreamName

String getUpstreamName()

Returns the name upstream uses for the software.

Example:

SOFTware

Returns:

The name or null, if no name is set.

getUpstreamContact

String getUpstreamContact()

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>

Returns:

The contact or null, if no contact is set.

getSource

String getSource()

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

Returns:

The source or null, if no source is set.

getDisclaimer

String getDisclaimer()

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.

Returns:

The disclaimer or null, if no disclaimer is set.

getComment

String getComment()

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.

Returns:

The comment or null, if no comment is set.

getLicense

CopyrightLicense getLicense()

Returns the license.

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

Returns:

The license or null, if no license is set.

getCopyright

String getCopyright()

Returns the copyright.

Example:

Copyright 2008 John Smith
Copyright 2009 Angela Watts

Returns:

The copyright or null, if no copyright is set.

getFilesCopyrights

List<FilesCopyright> getFilesCopyrights()

Returns the copyrights for certain files of a Debian package.

Returns:

The copyrights.

getLicenses

Map<String,CopyrightLicense> getLicenses()

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

Returns:

The licenses.

See Also:

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