Package com.google.gerrit.server.git.meta

Class VersionedConfigFile

java.lang.Object

com.google.gerrit.server.git.meta.VersionedMetaData

com.google.gerrit.server.git.meta.VersionedConfigFile

Direct Known Subclasses:

VersionedDefaultPreferences

public class VersionedConfigFile
extends VersionedMetaData

Versioned configuration file living in git

This class is a low-level API that allows callers to read the config directly from a repository and make updates to it.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gerrit.server.git.meta.VersionedMetaData

VersionedMetaData.BatchMetaDataUpdate, VersionedMetaData.PathInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.jgit.lib.Config	cfg
protected final String	defaultOnSaveMessage
protected final String	fileName
protected final String	ref

Fields inherited from class com.google.gerrit.server.git.meta.VersionedMetaData

inserter, newTree, projectName, reader, revision, rw

Constructor Summary

Constructors

Constructor	Description
VersionedConfigFile(String fileName)
VersionedConfigFile(String ref, String fileName)
VersionedConfigFile(String ref, String fileName, String defaultOnSaveMessage)

Method Summary

Modifier and Type	Method	Description
org.eclipse.jgit.lib.Config	getConfig()
protected String	getFileName()
protected String	getRefName()	Returns name of the reference storing this configuration.
protected void	onLoad()	Set up the metadata, parsing any state from the loaded revision.
protected boolean	onSave(org.eclipse.jgit.lib.CommitBuilder commit)	Save any changes to the metadata in a commit.

Methods inherited from class com.google.gerrit.server.git.meta.VersionedMetaData

commit, commit, commit, commitToNewRef, getObjectId, getPathInfos, getRevision, load, load, load, load, load, openUpdate, openUpdate, readConfig, readConfig, readFile, readTree, readUTF8, saveConfig, saveFile, saveUTF8, set, set, set

Methods inherited from class java.lang.Object

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

Field Details

ref

protected final String ref

fileName

protected final String fileName

defaultOnSaveMessage

protected final String defaultOnSaveMessage

cfg

protected org.eclipse.jgit.lib.Config cfg

Constructor Details

VersionedConfigFile

public VersionedConfigFile(String fileName)

VersionedConfigFile

public VersionedConfigFile(String ref,
 String fileName)

VersionedConfigFile

public VersionedConfigFile(String ref,
 String fileName,
 String defaultOnSaveMessage)

Method Details

getConfig

public org.eclipse.jgit.lib.Config getConfig()

getFileName

protected String getFileName()

getRefName

protected String getRefName()

Description copied from class: VersionedMetaData

Returns name of the reference storing this configuration.

Specified by:

getRefName in class VersionedMetaData

onLoad

protected void onLoad()
               throws IOException,
org.eclipse.jgit.errors.ConfigInvalidException

Description copied from class: VersionedMetaData

Set up the metadata, parsing any state from the loaded revision.

Specified by:

onLoad in class VersionedMetaData

Throws:

IOException

org.eclipse.jgit.errors.ConfigInvalidException

onSave

protected boolean onSave(org.eclipse.jgit.lib.CommitBuilder commit)
                  throws IOException,
org.eclipse.jgit.errors.ConfigInvalidException

Description copied from class: VersionedMetaData

Save any changes to the metadata in a commit.

Specified by:

onSave in class VersionedMetaData

Returns:

true if the commit should proceed, false to abort.

Throws:

IOException

org.eclipse.jgit.errors.ConfigInvalidException