net.sourceforge.javadpkg.impl

Class DocumentPathsImpl

java.lang.Object

net.sourceforge.javadpkg.impl.DocumentPathsImpl

All Implemented Interfaces:

DebianPackageConstants, DocumentPaths, GlobalConstants

public class DocumentPathsImpl
extends Object
implements DocumentPaths, DebianPackageConstants

A DocumentPaths implementation.

Version:

1.0, 06.05.2016 by Gerrit Hohl

Author:

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

Field Summary

Fields inherited from interface net.sourceforge.javadpkg.DebianPackageConstants

CONFFILES_ENTRY, CONFIG_ENTRY, CONTROL_ENTRY, CONTROL_NAME, CONTROL_TAR_PREFIX, DATA_NAME, DATA_TAR_PREFIX, DEBIAN_BINARY, DIRECTORY_MODE, DOC_BASE_PATH, FILE_MODE, MD5SUMS_ENTRY, POSTINST_ENTRY, POSTRM_ENTRY, PREINST_ENTRY, PRERM_ENTRY, ROOT_GROUP_ID, ROOT_GROUP_NAME, ROOT_USER_ID, ROOT_USER_NAME, SCRIPT_MODE, SHLIBS_ENTRY, SYMBOLS_ENTRY, TAR_BZIP2_SUFFIX, TAR_GZIP_SUFFIX, TAR_XZ_SUFFIX, TEMPLATES_ENTRY, TRIGGERS_ENTRY, USR_PATH, USR_SHARE_PATH

Fields inherited from interface net.sourceforge.javadpkg.GlobalConstants

UTF_8, UTF_8_CHARSET

Constructor Summary

Constructors

Constructor and Description
DocumentPathsImpl(PackageName name) Creates the paths.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentPathsImpl

public DocumentPathsImpl(PackageName name)

Creates the paths.

Parameters:

name - The name of the package.

Throws:

IllegalArgumentException - If the name is null.

Method Detail

getDocumentBasePath

public String getDocumentBasePath()

Description copied from interface: DocumentPaths

Returns the base path of the document folder.

Normally this should be:

/usr/share/doc/

Specified by:

getDocumentBasePath in interface DocumentPaths

Returns:

The base path.

getDocumentPath

public String getDocumentPath()

Description copied from interface: DocumentPaths

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

Normally this should be:

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

Specified by:

getDocumentPath in interface DocumentPaths

Returns:

The path.

isCopyrightPath

public boolean isCopyrightPath(String path)

Description copied from interface: DocumentPaths

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

Specified by:

isCopyrightPath in interface DocumentPaths

Parameters:

path - The path.

Returns:

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

getCopyrightPath

public String getCopyrightPath()

Description copied from interface: DocumentPaths

Returns the path of the copyright file.

Normally this should be:

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

Specified by:

getCopyrightPath in interface DocumentPaths

Returns:

The path.

isChangeLogPath

public boolean isChangeLogPath(String path)

Description copied from interface: DocumentPaths

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.

Specified by:

isChangeLogPath in interface DocumentPaths

Parameters:

path - The path.

Returns:

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

See Also:

DocumentPaths.isChangeLogGzipPath(String), DocumentPaths.isChangeLogHtmlPath(String)

isChangeLogDebianPath

public boolean isChangeLogDebianPath(String path)

Description copied from interface: DocumentPaths

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.

Specified by:

isChangeLogDebianPath in interface DocumentPaths

Parameters:

path - The path.

Returns:

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

isChangeLogGzipPath

public boolean isChangeLogGzipPath(String path)

Description copied from interface: DocumentPaths

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.

Specified by:

isChangeLogGzipPath in interface DocumentPaths

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:

DocumentPaths.isChangeLogHtmlPath(String)

isChangeLogHtmlPath

public boolean isChangeLogHtmlPath(String path)

Description copied from interface: DocumentPaths

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.

Specified by:

isChangeLogHtmlPath in interface DocumentPaths

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:

DocumentPaths.isChangeLogGzipPath(String)

getChangeLogPath

public String getChangeLogPath()

Description copied from interface: DocumentPaths

Returns the path of the change log file.

Normally this should be:

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

Specified by:

getChangeLogPath in interface DocumentPaths

Returns:

The path.

getChangeLogGzipPath

public String getChangeLogGzipPath()

Description copied from interface: DocumentPaths

Returns the path of the GZIP compressed change log file.

Normally this should be:

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

Specified by:

getChangeLogGzipPath in interface DocumentPaths

Returns:

The path.

getChangeLogHtmlPath

public String getChangeLogHtmlPath()

Description copied from interface: DocumentPaths

Returns the path of the HTML formatted change log file.

Normally this should be:

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

Specified by:

getChangeLogHtmlPath in interface DocumentPaths

Returns:

The path.

getChangeLogHtmlGzipPath

public String getChangeLogHtmlGzipPath()

Description copied from interface: DocumentPaths

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

Normally this should be:

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

Specified by:

getChangeLogHtmlGzipPath in interface DocumentPaths

Returns:

The path.