com.atlassian.clover.registry.format

Class RegFile<CDR extends RegFile>

java.lang.Object

com.atlassian.clover.registry.format.RegFile<CDR>

Type Parameters:

CDR - the next registry file state after save(java.util.List) } is called

Direct Known Subclasses:

FreshRegFile, UpdatableRegFile

public abstract class RegFile<CDR extends RegFile>
extends Object

The in-memory representation of a registry file's state. A registry file can only be updated/saved once after which the returned new instance of RegFile must be used.

Constructor Summary

Constructors

Constructor and Description
RegFile(File file)

Method Summary

Modifier and Type	Method and Description
abstract RegAccessMode	getAccessMode()
File	getFile()
abstract String	getName()
abstract boolean	isAppendable()
CDR	save(List<? extends RegistryUpdate> deltas) Saves a number of updates to the registry file on disk.
CDR	save(RegistryUpdate delta) Saves a single update to the registry file on disk.
protected abstract CDR	saveImpl(List<? extends RegistryUpdate> deltas) The meat of the save work - subclass specific
protected List<FileInfoRecord>	toRecords(Iterable<FullFileInfo> fileInfos)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegFile

public RegFile(File file)

Method Detail

save

public final CDR save(List<? extends RegistryUpdate> deltas)
               throws IOException,
                      CloverRegistryException

Saves a number of updates to the registry file on disk.

Returns:

CDR a RegFile instance that represents the updated registrty file's state

Throws:

IllegalStateException - if save has already been called

IOException

CloverRegistryException

save

public final CDR save(RegistryUpdate delta)
               throws IOException,
                      CloverRegistryException

Saves a single update to the registry file on disk.

Returns:

CDR a RegFile instance that represents the updated registrty file's state

Throws:

IllegalStateException - if save has already been called

IOException

CloverRegistryException

saveImpl

protected abstract CDR saveImpl(List<? extends RegistryUpdate> deltas)
                         throws IOException,
                                CloverRegistryException

The meat of the save work - subclass specific

Throws:

IOException

CloverRegistryException

getName

public abstract String getName()

Returns:

the name of the registry (note: not the file name)

getFile

public File getFile()

toRecords

protected List<FileInfoRecord> toRecords(Iterable<FullFileInfo> fileInfos)

getAccessMode

public abstract RegAccessMode getAccessMode()

isAppendable

public abstract boolean isAppendable()