net.sourceforge.javadpkg

Interface DocumentPaths

All Known Implementing Classes:

DocumentPathsImpl

public interface DocumentPaths

The paths of the files in the document folder of the Debian package.

Version:

1.0, 06.05.2016 by Gerrit Hohl

Author:

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

Method Summary

Modifier and Type	Method and Description
String	getChangeLogGzipPath() Returns the path of the GZIP compressed change log file.
String	getChangeLogHtmlGzipPath() Returns the path of the GZIP compressed HTML formatted change log file.
String	getChangeLogHtmlPath() Returns the path of the HTML formatted change log file.
String	getChangeLogPath() Returns the path of the change log file.
String	getCopyrightPath() Returns the path of the copyright file.
String	getDocumentBasePath() Returns the base path of the document folder.
String	getDocumentPath() Returns the path of the document folder of the Debian package.
boolean	isChangeLogDebianPath(String path) Returns the flag if the specified path is the path of the Debian change log file.
boolean	isChangeLogGzipPath(String path) Returns the flag if the specified path is the path of a GZIP compressed change log file.
boolean	isChangeLogHtmlPath(String path) Returns the flag if the specified path is the path of a HTML formatted change log file.
boolean	isChangeLogPath(String path) Returns the flag if the specified path is the path of the change log file.
boolean	isCopyrightPath(String path) Returns the flag if the specified path is the path of the copyright file.

Method Detail

getDocumentBasePath

String getDocumentBasePath()

Returns the base path of the document folder.

Normally this should be:

/usr/share/doc/

Returns:

The base path.

getDocumentPath

String getDocumentPath()

Returns the path of the document folder of the Debian package.

Normally this should be:

/usr/share/doc/[package-name]/

Returns:

The path.

isCopyrightPath

boolean isCopyrightPath(String path)

Returns the flag if the specified path is the path of the copyright file.

Parameters:

path - The path.

Returns:

The flag: true, if the path is the path of the copyright file, false otherwise.

Throws:

IllegalArgumentException - If the path is null.

getCopyrightPath

String getCopyrightPath()

Returns the path of the copyright file.

Normally this should be:

/usr/share/doc/[package-name]/copyright

Returns:

The path.

isChangeLogPath

boolean isChangeLogPath(String path)

Returns the flag if the specified path is the path of the change log file.

The method doesn't determine the format and/or compression of the change log file.

Parameters:

path - The path.

Returns:

The flag: true, if the path is the path of the change log file, false otherwise.

Throws:

IllegalArgumentException - If the path is null.

See Also:

isChangeLogGzipPath(String), isChangeLogHtmlPath(String)

isChangeLogDebianPath

boolean isChangeLogDebianPath(String path)

Returns the flag if the specified path is the path of the Debian change log file.

The filename of the Debian change log starts with "changelog.Debian.*". It often exists parallel to the "changelog.*" file which in this case has its own, non-standard format. If both files exists the Debian change log should always be used.

Parameters:

path - The path.

Returns:

The flag: true, if the path is the path of the Debian change log file, false otherwise.

Throws:

IllegalArgumentException - If the path is null.

isChangeLogGzipPath

boolean isChangeLogGzipPath(String path)

Returns the flag if the specified path is the path of a GZIP compressed change log file.

The method doesn't determine the format of the change log file.

Parameters:

path - The path.

Returns:

The flag: true, if the path is the path of a GZIP compressed change log file, false otherwise.

See Also:

isChangeLogHtmlPath(String)

isChangeLogHtmlPath

boolean isChangeLogHtmlPath(String path)

Returns the flag if the specified path is the path of a HTML formatted change log file.

The method doesn't determine the compression of the change log file.

Parameters:

path - The path.

Returns:

The flag: true, if the path is the path of a HTML formatted change log file, false otherwise.

See Also:

isChangeLogGzipPath(String)

getChangeLogPath

String getChangeLogPath()

Returns the path of the change log file.

Normally this should be:

/usr/share/doc/[package-name]/changelog

Returns:

The path.

getChangeLogGzipPath

String getChangeLogGzipPath()

Returns the path of the GZIP compressed change log file.

Normally this should be:

/usr/share/doc/[package-name]/changelog.gz

Returns:

The path.

getChangeLogHtmlPath

String getChangeLogHtmlPath()

Returns the path of the HTML formatted change log file.

Normally this should be:

/usr/share/doc/[package-name]/changelog.html

Returns:

The path.

getChangeLogHtmlGzipPath

String getChangeLogHtmlGzipPath()

Returns the path of the GZIP compressed HTML formatted change log file.

Normally this should be:

/usr/share/doc/[package-name]/changelog.html.gz

Returns:

The path.