org.expath.pkg.repo.tools

Class PackagesXmlFile

java.lang.Object

org.expath.pkg.repo.tools.UpdatableFile

org.expath.pkg.repo.tools.UpdatableXmlFile

org.expath.pkg.repo.tools.PackagesXmlFile

public class PackagesXmlFile
extends UpdatableXmlFile

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

Author:

Florent Georges

Field Summary

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

myFile

Constructor Summary

Constructors

Constructor and Description
PackagesXmlFile(java.nio.file.Path file) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	addPackage(Package pkg, java.lang.String dir) Add a package to packages.xml.
protected void	createEmpty(java.io.Writer out) Create an empty file.
void	removePackageByDir(java.lang.String dir) Remove a package from packages.xml.

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

compile, transform

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

PackagesXmlFile

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

Create a new instance. If the file does not exist yet, it is created.

Parameters:

file - The actual file, for [repo]/.expath-pkg/packages.xml.

Throws:

PackageException - If any error when creating the file (if it does not exist yet).

Method Detail

addPackage

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

Add a package to packages.xml.

Parameters:

pkg - The package to add.

dir - The name of the directory where the package is installed, right below the repository root.

Throws:

PackageException - In case of any error (mostly related to I/Os).

removePackageByDir

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

Remove a package from packages.xml. The package is identified by its directory name (the name of the directory where it is installed, right below the repository root).

Parameters:

dir - The directory to remove from the packages file.

Throws:

PackageException - In case of any error transforming the packages file.

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.