org.expath.pkg.repo.tools

Class PackagesTxtFile

java.lang.Object

org.expath.pkg.repo.tools.UpdatableFile

org.expath.pkg.repo.tools.PackagesTxtFile

public class PackagesTxtFile
extends UpdatableFile

Represent the file [repo]/.expath-pkg/packages.txt.

Author:

Florent Georges

Field Summary

Fields inherited from class org.expath.pkg.repo.tools.UpdatableFile

myFile

Constructor Summary

Constructors

Constructor and Description
PackagesTxtFile(java.nio.file.Path file)

Method Summary

Modifier and Type	Method and Description
void	addPackage(Package pkg, java.lang.String pkg_dir)
protected void	createEmpty(java.io.Writer out) Create an empty file.
java.util.Set<java.lang.String>	parseDirectories() Return the names of all the package directories, as a set.
static java.util.Set<java.lang.String>	parseDirectories(java.io.InputStream stream) Return the names of all the package directories, as a set.
void	removePackageByDir(java.lang.String dir)

Methods inherited from class org.expath.pkg.repo.tools.UpdatableFile

update

Methods inherited from class java.lang.Object

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

Constructor Detail

PackagesTxtFile

public PackagesTxtFile(java.nio.file.Path file)
                throws PackageException

Throws:

PackageException

Method Detail

addPackage

public void addPackage(Package pkg,
                       java.lang.String pkg_dir)
                throws PackageException

Throws:

PackageException

removePackageByDir

public void removePackageByDir(java.lang.String dir)
                        throws PackageException

Throws:

PackageException

parseDirectories

public java.util.Set<java.lang.String> parseDirectories()
                                                 throws PackageException

Return the names of all the package directories, as a set. TODO: Cache them! (easy now, as all update go through this class)

Returns:

the package directories

Throws:

PackageException - if an error occurs

parseDirectories

public static java.util.Set<java.lang.String> parseDirectories(java.io.InputStream stream)
                                                        throws PackageException

Return the names of all the package directories, as a set. This is a utility method for systems where packages.txt is not stored as an actual file (for instance on classpath storages).

Parameters:

stream - the input stream

Returns:

the package directories

Throws:

PackageException - if an error occurs

createEmpty

protected void createEmpty(java.io.Writer out)
                    throws java.io.IOException

Description copied from class: UpdatableFile

Create an empty file. By empty, means without any record. If this is an XML file for instance, it might have the root element. No need to close the writer, it is done automatically.

Specified by:

createEmpty in class UpdatableFile

Parameters:

out - the writer for the file.

Throws:

java.io.IOException - if an error occurs whilst writing the empty file.