org.expath.pkg.repo.tools

Class UpdatableFile

java.lang.Object

org.expath.pkg.repo.tools.UpdatableFile

Direct Known Subclasses:

PackagesTxtFile, UpdatableXmlFile

public abstract class UpdatableFile
extends java.lang.Object

A file that can be updated.

Author:

Florent Georges

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.Path	myFile The actual file object.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract void	createEmpty(java.io.Writer out) Create an empty file.
protected void	update(java.io.StringWriter content) Replace the actual file with content.

Methods inherited from class java.lang.Object

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

Field Detail

myFile

protected java.nio.file.Path myFile

The actual file object.

Constructor Detail

UpdatableFile

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

Throws:

PackageException

Method Detail

createEmpty

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

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.

Parameters:

out - the writer for the file.

Throws:

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

update

protected void update(java.io.StringWriter content)
               throws PackageException

Replace the actual file with content.

Parameters:

content - the new content

Throws:

PackageException - if an error occurs